externalsecret_controller.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643
  1. /*
  2. Licensed under the Apache License, Version 2.0 (the "License");
  3. you may not use this file except in compliance with the License.
  4. You may obtain a copy of the License at
  5. http://www.apache.org/licenses/LICENSE-2.0
  6. Unless required by applicable law or agreed to in writing, software
  7. distributed under the License is distributed on an "AS IS" BASIS,
  8. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  9. See the License for the specific language governing permissions and
  10. limitations under the License.
  11. */
  12. package externalsecret
  13. import (
  14. "context"
  15. "encoding/json"
  16. "fmt"
  17. "strings"
  18. "time"
  19. "github.com/go-logr/logr"
  20. "github.com/prometheus/client_golang/prometheus"
  21. v1 "k8s.io/api/core/v1"
  22. "k8s.io/apimachinery/pkg/api/equality"
  23. apierrors "k8s.io/apimachinery/pkg/api/errors"
  24. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  25. "k8s.io/apimachinery/pkg/runtime"
  26. "k8s.io/apimachinery/pkg/types"
  27. "k8s.io/client-go/rest"
  28. "k8s.io/client-go/tools/record"
  29. ctrl "sigs.k8s.io/controller-runtime"
  30. "sigs.k8s.io/controller-runtime/pkg/builder"
  31. "sigs.k8s.io/controller-runtime/pkg/client"
  32. "sigs.k8s.io/controller-runtime/pkg/controller"
  33. "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
  34. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  35. // Metrics.
  36. "github.com/external-secrets/external-secrets/pkg/controllers/externalsecret/esmetrics"
  37. ctrlmetrics "github.com/external-secrets/external-secrets/pkg/controllers/metrics"
  38. // Loading registered generators.
  39. _ "github.com/external-secrets/external-secrets/pkg/generator/register"
  40. // Loading registered providers.
  41. _ "github.com/external-secrets/external-secrets/pkg/provider/register"
  42. "github.com/external-secrets/external-secrets/pkg/utils"
  43. )
  44. const (
  45. fieldOwnerTemplate = "externalsecrets.external-secrets.io/%v"
  46. errGetES = "could not get ExternalSecret"
  47. errConvert = "could not apply conversion strategy to keys: %v"
  48. errDecode = "could not apply decoding strategy to %v[%d]: %v"
  49. errGenerate = "could not generate [%d]: %w"
  50. errRewrite = "could not rewrite spec.dataFrom[%d]: %v"
  51. errInvalidKeys = "secret keys from spec.dataFrom.%v[%d] can only have alphanumeric,'-', '_' or '.' characters. Convert them using rewrite (https://external-secrets.io/latest/guides-datafrom-rewrite)"
  52. errUpdateSecret = "could not update Secret"
  53. errPatchStatus = "unable to patch status"
  54. errStoreRef = "could not get store reference"
  55. errStoreUsability = "could not use store reference"
  56. errStoreProvider = "could not get store provider"
  57. errStoreClient = "could not get provider client"
  58. errGetExistingSecret = "could not get existing secret: %w"
  59. errCloseStoreClient = "could not close provider client"
  60. errSetCtrlReference = "could not set ExternalSecret controller reference: %w"
  61. errFetchTplFrom = "error fetching templateFrom data: %w"
  62. errGetSecretData = "could not get secret data from provider"
  63. errDeleteSecret = "could not delete secret"
  64. errApplyTemplate = "could not apply template: %w"
  65. errExecTpl = "could not execute template: %w"
  66. errInvalidCreatePolicy = "invalid creationPolicy=%s. Can not delete secret i do not own"
  67. errPolicyMergeNotFound = "the desired secret %s was not found. With creationPolicy=Merge the secret won't be created"
  68. errPolicyMergeGetSecret = "unable to get secret %s: %w"
  69. errPolicyMergeMutate = "unable to mutate secret %s: %w"
  70. errPolicyMergePatch = "unable to patch secret %s: %w"
  71. errTplCMMissingKey = "error in configmap %s: missing key %s"
  72. errTplSecMissingKey = "error in secret %s: missing key %s"
  73. )
  74. // Reconciler reconciles a ExternalSecret object.
  75. type Reconciler struct {
  76. client.Client
  77. Log logr.Logger
  78. Scheme *runtime.Scheme
  79. RestConfig *rest.Config
  80. ControllerClass string
  81. RequeueInterval time.Duration
  82. ClusterSecretStoreEnabled bool
  83. EnableFloodGate bool
  84. recorder record.EventRecorder
  85. }
  86. // Reconcile implements the main reconciliation loop
  87. // for watched objects (ExternalSecret, ClusterSecretStore and SecretStore),
  88. // and updates/creates a Kubernetes secret based on them.
  89. func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
  90. log := r.Log.WithValues("ExternalSecret", req.NamespacedName)
  91. resourceLabels := ctrlmetrics.RefineNonConditionMetricLabels(map[string]string{"name": req.Name, "namespace": req.Namespace})
  92. start := time.Now()
  93. syncCallsError := esmetrics.GetCounterVec(esmetrics.SyncCallsErrorKey)
  94. // use closures to dynamically update resourceLabels
  95. defer func() {
  96. esmetrics.GetGaugeVec(esmetrics.ExternalSecretReconcileDurationKey).With(resourceLabels).Set(float64(time.Since(start)))
  97. esmetrics.GetCounterVec(esmetrics.SyncCallsKey).With(resourceLabels).Inc()
  98. }()
  99. var externalSecret esv1beta1.ExternalSecret
  100. err := r.Get(ctx, req.NamespacedName, &externalSecret)
  101. if err != nil {
  102. if apierrors.IsNotFound(err) {
  103. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretDeleted, v1.ConditionFalse, esv1beta1.ConditionReasonSecretDeleted, "Secret was deleted")
  104. SetExternalSecretCondition(&esv1beta1.ExternalSecret{
  105. ObjectMeta: metav1.ObjectMeta{
  106. Name: req.Name,
  107. Namespace: req.Namespace,
  108. },
  109. }, *conditionSynced)
  110. return ctrl.Result{}, nil
  111. }
  112. log.Error(err, errGetES)
  113. syncCallsError.With(resourceLabels).Inc()
  114. return ctrl.Result{}, err
  115. }
  116. timeSinceLastRefresh := 0 * time.Second
  117. if !externalSecret.Status.RefreshTime.IsZero() {
  118. timeSinceLastRefresh = time.Since(externalSecret.Status.RefreshTime.Time)
  119. }
  120. // skip reconciliation if deletion timestamp is set on external secret
  121. if externalSecret.DeletionTimestamp != nil {
  122. log.Info("skipping as it is in deletion")
  123. return ctrl.Result{}, nil
  124. }
  125. // if extended metrics is enabled, refine the time series vector
  126. resourceLabels = ctrlmetrics.RefineLabels(resourceLabels, externalSecret.Labels)
  127. if shouldSkipClusterSecretStore(r, externalSecret) {
  128. log.Info("skipping cluster secret store as it is disabled")
  129. return ctrl.Result{}, nil
  130. }
  131. // skip when pointing to an unmanaged store
  132. skip, err := shouldSkipUnmanagedStore(ctx, req.Namespace, r, externalSecret)
  133. if skip {
  134. log.Info("skipping unmanaged store as it points to a unmanaged controllerClass")
  135. return ctrl.Result{}, nil
  136. }
  137. refreshInt := r.RequeueInterval
  138. if externalSecret.Spec.RefreshInterval != nil {
  139. refreshInt = externalSecret.Spec.RefreshInterval.Duration
  140. }
  141. // Target Secret Name should default to the ExternalSecret name if not explicitly specified
  142. secretName := externalSecret.Spec.Target.Name
  143. if secretName == "" {
  144. secretName = externalSecret.ObjectMeta.Name
  145. }
  146. // fetch external secret, we need to ensure that it exists, and it's hashmap corresponds
  147. var existingSecret v1.Secret
  148. err = r.Get(ctx, types.NamespacedName{
  149. Name: secretName,
  150. Namespace: externalSecret.Namespace,
  151. }, &existingSecret)
  152. if err != nil && !apierrors.IsNotFound(err) {
  153. log.Error(err, errGetExistingSecret)
  154. return ctrl.Result{}, err
  155. }
  156. // refresh should be skipped if
  157. // 1. resource generation hasn't changed
  158. // 2. refresh interval is 0
  159. // 3. if we're still within refresh-interval
  160. if !shouldRefresh(externalSecret) && isSecretValid(existingSecret) {
  161. refreshInt = (externalSecret.Spec.RefreshInterval.Duration - timeSinceLastRefresh) + 5*time.Second
  162. log.V(1).Info("skipping refresh", "rv", getResourceVersion(externalSecret), "nr", refreshInt.Seconds())
  163. return ctrl.Result{RequeueAfter: refreshInt}, nil
  164. }
  165. if !shouldReconcile(externalSecret) {
  166. log.V(1).Info("stopping reconciling", "rv", getResourceVersion(externalSecret))
  167. return ctrl.Result{}, nil
  168. }
  169. // patch status when done processing
  170. p := client.MergeFrom(externalSecret.DeepCopy())
  171. defer func() {
  172. err = r.Status().Patch(ctx, &externalSecret, p)
  173. if err != nil {
  174. log.Error(err, errPatchStatus)
  175. }
  176. }()
  177. secret := &v1.Secret{
  178. ObjectMeta: metav1.ObjectMeta{
  179. Name: secretName,
  180. Namespace: externalSecret.Namespace,
  181. },
  182. Immutable: &externalSecret.Spec.Target.Immutable,
  183. Data: make(map[string][]byte),
  184. }
  185. dataMap, err := r.getProviderSecretData(ctx, &externalSecret)
  186. if err != nil {
  187. r.markAsFailed(log, errGetSecretData, err, &externalSecret, syncCallsError.With(resourceLabels))
  188. return ctrl.Result{}, err
  189. }
  190. // if no data was found we can delete the secret if needed.
  191. if len(dataMap) == 0 {
  192. switch externalSecret.Spec.Target.DeletionPolicy {
  193. // delete secret and return early.
  194. case esv1beta1.DeletionPolicyDelete:
  195. // safeguard that we only can delete secrets we own
  196. // this is also implemented in the es validation webhook
  197. if externalSecret.Spec.Target.CreationPolicy != esv1beta1.CreatePolicyOwner {
  198. err := fmt.Errorf(errInvalidCreatePolicy, externalSecret.Spec.Target.CreationPolicy)
  199. r.markAsFailed(log, errDeleteSecret, err, &externalSecret, syncCallsError.With(resourceLabels))
  200. return ctrl.Result{}, err
  201. }
  202. err = r.Delete(ctx, secret)
  203. if err != nil && !apierrors.IsNotFound(err) {
  204. r.markAsFailed(log, errDeleteSecret, err, &externalSecret, syncCallsError.With(resourceLabels))
  205. }
  206. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretDeleted, "secret deleted due to DeletionPolicy")
  207. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  208. return ctrl.Result{RequeueAfter: refreshInt}, err
  209. case esv1beta1.DeletionPolicyMerge:
  210. // noop, handled below
  211. // In case provider secrets don't exist the kubernetes secret will be kept as-is.
  212. case esv1beta1.DeletionPolicyRetain:
  213. return ctrl.Result{RequeueAfter: refreshInt}, nil
  214. }
  215. }
  216. mutationFunc := func() error {
  217. if externalSecret.Spec.Target.CreationPolicy == esv1beta1.CreatePolicyOwner {
  218. err = controllerutil.SetControllerReference(&externalSecret, &secret.ObjectMeta, r.Scheme)
  219. if err != nil {
  220. return fmt.Errorf(errSetCtrlReference, err)
  221. }
  222. }
  223. if secret.Data == nil {
  224. secret.Data = make(map[string][]byte)
  225. }
  226. // diff existing keys
  227. keys, err := getManagedDataKeys(&existingSecret, externalSecret.Name)
  228. if err != nil {
  229. return err
  230. }
  231. // Sanitize data map for any updates on the ES
  232. for _, key := range keys {
  233. if dataMap[key] == nil {
  234. secret.Data[key] = nil
  235. // Sanitizing any templated / updated keys
  236. delete(secret.Data, key)
  237. }
  238. }
  239. err = r.applyTemplate(ctx, &externalSecret, secret, dataMap)
  240. if err != nil {
  241. return fmt.Errorf(errApplyTemplate, err)
  242. }
  243. if externalSecret.Spec.Target.CreationPolicy == esv1beta1.CreatePolicyOwner {
  244. lblValue := utils.ObjectHash(fmt.Sprintf("%v/%v", externalSecret.Namespace, externalSecret.Name))
  245. secret.Labels[esv1beta1.LabelOwner] = lblValue
  246. }
  247. secret.Annotations[esv1beta1.AnnotationDataHash] = r.computeDataHashAnnotation(&existingSecret, secret)
  248. return nil
  249. }
  250. switch externalSecret.Spec.Target.CreationPolicy { //nolint:exhaustive
  251. case esv1beta1.CreatePolicyMerge:
  252. err = patchSecret(ctx, r.Client, r.Scheme, secret, mutationFunc, externalSecret.Name)
  253. if err == nil {
  254. externalSecret.Status.Binding = v1.LocalObjectReference{Name: secret.Name}
  255. }
  256. case esv1beta1.CreatePolicyNone:
  257. log.V(1).Info("secret creation skipped due to creationPolicy=None")
  258. err = nil
  259. default:
  260. var created bool
  261. created, err = createOrUpdate(ctx, r.Client, secret, mutationFunc, externalSecret.Name)
  262. if err == nil {
  263. externalSecret.Status.Binding = v1.LocalObjectReference{Name: secret.Name}
  264. }
  265. // cleanup orphaned secrets
  266. if created {
  267. delErr := deleteOrphanedSecrets(ctx, r.Client, &externalSecret)
  268. if delErr != nil {
  269. msg := fmt.Sprintf("failed to clean up orphaned secrets: %v", delErr)
  270. r.markAsFailed(log, msg, delErr, &externalSecret, syncCallsError.With(resourceLabels))
  271. return ctrl.Result{}, delErr
  272. }
  273. }
  274. }
  275. if err != nil {
  276. r.markAsFailed(log, errUpdateSecret, err, &externalSecret, syncCallsError.With(resourceLabels))
  277. return ctrl.Result{}, err
  278. }
  279. r.markAsDone(&externalSecret, start, log)
  280. return ctrl.Result{
  281. RequeueAfter: refreshInt,
  282. }, nil
  283. }
  284. func (r *Reconciler) markAsDone(externalSecret *esv1beta1.ExternalSecret, start time.Time, log logr.Logger) {
  285. r.recorder.Event(externalSecret, v1.EventTypeNormal, esv1beta1.ReasonUpdated, "Updated Secret")
  286. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretSynced, "Secret was synced")
  287. currCond := GetExternalSecretCondition(externalSecret.Status, esv1beta1.ExternalSecretReady)
  288. SetExternalSecretCondition(externalSecret, *conditionSynced)
  289. externalSecret.Status.RefreshTime = metav1.NewTime(start)
  290. externalSecret.Status.SyncedResourceVersion = getResourceVersion(*externalSecret)
  291. if currCond == nil || currCond.Status != conditionSynced.Status {
  292. log.Info("reconciled secret") // Log once if on success in any verbosity
  293. } else {
  294. log.V(1).Info("reconciled secret") // Log all reconciliation cycles if higher verbosity applied
  295. }
  296. }
  297. func (r *Reconciler) markAsFailed(log logr.Logger, msg string, err error, externalSecret *esv1beta1.ExternalSecret, counter prometheus.Counter) {
  298. log.Error(err, msg)
  299. r.recorder.Event(externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  300. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, msg)
  301. SetExternalSecretCondition(externalSecret, *conditionSynced)
  302. counter.Inc()
  303. }
  304. func deleteOrphanedSecrets(ctx context.Context, cl client.Client, externalSecret *esv1beta1.ExternalSecret) error {
  305. secretList := v1.SecretList{}
  306. lblValue := utils.ObjectHash(fmt.Sprintf("%v/%v", externalSecret.Namespace, externalSecret.Name))
  307. ls := &metav1.LabelSelector{
  308. MatchLabels: map[string]string{
  309. esv1beta1.LabelOwner: lblValue,
  310. },
  311. }
  312. labelSelector, err := metav1.LabelSelectorAsSelector(ls)
  313. if err != nil {
  314. return err
  315. }
  316. err = cl.List(ctx, &secretList, &client.ListOptions{LabelSelector: labelSelector})
  317. if err != nil {
  318. return err
  319. }
  320. for key, secret := range secretList.Items {
  321. if externalSecret.Spec.Target.Name != "" && secret.Name != externalSecret.Spec.Target.Name {
  322. err = cl.Delete(ctx, &secretList.Items[key])
  323. if err != nil {
  324. return err
  325. }
  326. }
  327. }
  328. return nil
  329. }
  330. func createOrUpdate(ctx context.Context, c client.Client, obj client.Object, f func() error, fieldOwner string) (bool, error) {
  331. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  332. key := client.ObjectKeyFromObject(obj)
  333. if err := c.Get(ctx, key, obj); err != nil {
  334. if !apierrors.IsNotFound(err) {
  335. return false, err
  336. }
  337. if err := f(); err != nil {
  338. return false, err
  339. }
  340. // Setting Field Owner even for CreationPolicy==Create
  341. if err := c.Create(ctx, obj, client.FieldOwner(fqdn)); err != nil {
  342. return false, err
  343. }
  344. return true, nil
  345. }
  346. existing := obj.DeepCopyObject()
  347. if err := f(); err != nil {
  348. return false, err
  349. }
  350. if equality.Semantic.DeepEqual(existing, obj) {
  351. return false, nil
  352. }
  353. if err := c.Update(ctx, obj, client.FieldOwner(fqdn)); err != nil {
  354. return false, err
  355. }
  356. return false, nil
  357. }
  358. func patchSecret(ctx context.Context, c client.Client, scheme *runtime.Scheme, secret *v1.Secret, mutationFunc func() error, fieldOwner string) error {
  359. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  360. err := c.Get(ctx, client.ObjectKeyFromObject(secret), secret.DeepCopy())
  361. if apierrors.IsNotFound(err) {
  362. return fmt.Errorf(errPolicyMergeNotFound, secret.Name)
  363. }
  364. if err != nil {
  365. return fmt.Errorf(errPolicyMergeGetSecret, secret.Name, err)
  366. }
  367. existing := secret.DeepCopyObject()
  368. err = mutationFunc()
  369. if err != nil {
  370. return fmt.Errorf(errPolicyMergeMutate, secret.Name, err)
  371. }
  372. // GVK is missing in the Secret, see:
  373. // https://github.com/kubernetes-sigs/controller-runtime/issues/526
  374. // https://github.com/kubernetes-sigs/controller-runtime/issues/1517
  375. // https://github.com/kubernetes/kubernetes/issues/80609
  376. // we need to manually set it before doing a Patch() as it depends on the GVK
  377. gvks, unversioned, err := scheme.ObjectKinds(secret)
  378. if err != nil {
  379. return err
  380. }
  381. if !unversioned && len(gvks) == 1 {
  382. secret.SetGroupVersionKind(gvks[0])
  383. }
  384. if equality.Semantic.DeepEqual(existing, secret) {
  385. return nil
  386. }
  387. // Cleaning up Managed fields manually as to keep patch coherence
  388. secret.ObjectMeta.ManagedFields = nil
  389. // we're not able to resolve conflicts so we force ownership
  390. // see: https://kubernetes.io/docs/reference/using-api/server-side-apply/#using-server-side-apply-in-a-controller
  391. err = c.Patch(ctx, secret, client.Apply, client.FieldOwner(fqdn), client.ForceOwnership)
  392. if err != nil {
  393. return fmt.Errorf(errPolicyMergePatch, secret.Name, err)
  394. }
  395. return nil
  396. }
  397. func getManagedDataKeys(secret *v1.Secret, fieldOwner string) ([]string, error) {
  398. return getManagedFieldKeys(secret, fieldOwner, func(fields map[string]interface{}) []string {
  399. dataFields := fields["f:data"]
  400. if dataFields == nil {
  401. return nil
  402. }
  403. df, ok := dataFields.(map[string]interface{})
  404. if !ok {
  405. return nil
  406. }
  407. var keys []string
  408. for k := range df {
  409. keys = append(keys, k)
  410. }
  411. return keys
  412. })
  413. }
  414. func getManagedFieldKeys(
  415. secret *v1.Secret,
  416. fieldOwner string,
  417. process func(fields map[string]interface{}) []string,
  418. ) ([]string, error) {
  419. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  420. var keys []string
  421. for _, v := range secret.ObjectMeta.ManagedFields {
  422. if v.Manager != fqdn {
  423. continue
  424. }
  425. fields := make(map[string]interface{})
  426. err := json.Unmarshal(v.FieldsV1.Raw, &fields)
  427. if err != nil {
  428. return nil, fmt.Errorf("error unmarshaling managed fields: %w", err)
  429. }
  430. for _, key := range process(fields) {
  431. if key == "." {
  432. continue
  433. }
  434. keys = append(keys, strings.TrimPrefix(key, "f:"))
  435. }
  436. }
  437. return keys, nil
  438. }
  439. func getResourceVersion(es esv1beta1.ExternalSecret) string {
  440. return fmt.Sprintf("%d-%s", es.ObjectMeta.GetGeneration(), hashMeta(es.ObjectMeta))
  441. }
  442. func hashMeta(m metav1.ObjectMeta) string {
  443. type meta struct {
  444. annotations map[string]string
  445. labels map[string]string
  446. }
  447. return utils.ObjectHash(meta{
  448. annotations: m.Annotations,
  449. labels: m.Labels,
  450. })
  451. }
  452. func shouldSkipClusterSecretStore(r *Reconciler, es esv1beta1.ExternalSecret) bool {
  453. return !r.ClusterSecretStoreEnabled && es.Spec.SecretStoreRef.Kind == esv1beta1.ClusterSecretStoreKind
  454. }
  455. // shouldSkipUnmanagedStore iterates over all secretStore references in the externalSecret spec,
  456. // fetches the store and evaluates the controllerClass property.
  457. // Returns true if any storeRef points to store with a non-matching controllerClass.
  458. func shouldSkipUnmanagedStore(ctx context.Context, namespace string, r *Reconciler, es esv1beta1.ExternalSecret) (bool, error) {
  459. var storeList []esv1beta1.SecretStoreRef
  460. if es.Spec.SecretStoreRef.Name != "" {
  461. storeList = append(storeList, es.Spec.SecretStoreRef)
  462. }
  463. for _, ref := range es.Spec.Data {
  464. if ref.SourceRef != nil {
  465. storeList = append(storeList, ref.SourceRef.SecretStoreRef)
  466. }
  467. }
  468. for _, ref := range es.Spec.DataFrom {
  469. if ref.SourceRef != nil && ref.SourceRef.SecretStoreRef != nil {
  470. storeList = append(storeList, *ref.SourceRef.SecretStoreRef)
  471. }
  472. // verify that generator's controllerClass matches
  473. if ref.SourceRef != nil && ref.SourceRef.GeneratorRef != nil {
  474. genDef, err := r.getGeneratorDefinition(ctx, namespace, ref.SourceRef.GeneratorRef)
  475. if err != nil {
  476. return false, err
  477. }
  478. skipGenerator, err := shouldSkipGenerator(r, genDef)
  479. if err != nil {
  480. return false, err
  481. }
  482. if skipGenerator {
  483. return true, nil
  484. }
  485. }
  486. }
  487. for _, ref := range storeList {
  488. var store esv1beta1.GenericStore
  489. switch ref.Kind {
  490. case esv1beta1.SecretStoreKind, "":
  491. store = &esv1beta1.SecretStore{}
  492. case esv1beta1.ClusterSecretStoreKind:
  493. store = &esv1beta1.ClusterSecretStore{}
  494. namespace = ""
  495. }
  496. err := r.Client.Get(ctx, types.NamespacedName{
  497. Name: ref.Name,
  498. Namespace: namespace,
  499. }, store)
  500. if err != nil {
  501. return false, err
  502. }
  503. class := store.GetSpec().Controller
  504. if class != "" && class != r.ControllerClass {
  505. return true, nil
  506. }
  507. }
  508. return false, nil
  509. }
  510. func shouldRefresh(es esv1beta1.ExternalSecret) bool {
  511. // refresh if resource version changed
  512. if es.Status.SyncedResourceVersion != getResourceVersion(es) {
  513. return true
  514. }
  515. // skip refresh if refresh interval is 0
  516. if es.Spec.RefreshInterval.Duration == 0 && es.Status.SyncedResourceVersion != "" {
  517. return false
  518. }
  519. if es.Status.RefreshTime.IsZero() {
  520. return true
  521. }
  522. return es.Status.RefreshTime.Add(es.Spec.RefreshInterval.Duration).Before(time.Now())
  523. }
  524. func shouldReconcile(es esv1beta1.ExternalSecret) bool {
  525. if es.Spec.Target.Immutable && hasSyncedCondition(es) {
  526. return false
  527. }
  528. return true
  529. }
  530. func hasSyncedCondition(es esv1beta1.ExternalSecret) bool {
  531. for _, condition := range es.Status.Conditions {
  532. if condition.Reason == "SecretSynced" {
  533. return true
  534. }
  535. }
  536. return false
  537. }
  538. // isSecretValid checks if the secret exists, and it's data is consistent with the calculated hash.
  539. func isSecretValid(existingSecret v1.Secret) bool {
  540. // if target secret doesn't exist, or annotations as not set, we need to refresh
  541. if existingSecret.UID == "" || existingSecret.Annotations == nil {
  542. return false
  543. }
  544. // if the calculated hash is different from the calculation, then it's invalid
  545. if existingSecret.Annotations[esv1beta1.AnnotationDataHash] != utils.ObjectHash(existingSecret.Data) {
  546. return false
  547. }
  548. return true
  549. }
  550. // computeDataHashAnnotation generate a hash of the secret data combining the old key with the new keys to add or override.
  551. func (r *Reconciler) computeDataHashAnnotation(existing, secret *v1.Secret) string {
  552. data := make(map[string][]byte)
  553. for k, v := range existing.Data {
  554. data[k] = v
  555. }
  556. for k, v := range secret.Data {
  557. data[k] = v
  558. }
  559. return utils.ObjectHash(data)
  560. }
  561. // SetupWithManager returns a new controller builder that will be started by the provided Manager.
  562. func (r *Reconciler) SetupWithManager(mgr ctrl.Manager, opts controller.Options) error {
  563. r.recorder = mgr.GetEventRecorderFor("external-secrets")
  564. return ctrl.NewControllerManagedBy(mgr).
  565. WithOptions(opts).
  566. For(&esv1beta1.ExternalSecret{}).
  567. Owns(&v1.Secret{}, builder.OnlyMetadata).
  568. Complete(r)
  569. }