qontract-reconcile 0.10.1rc1188__py3-none-any.whl → 0.10.1rc1189__py3-none-any.whl

{qontract_reconcile-0.10.1rc1188.dist-info → qontract_reconcile-0.10.1rc1189.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qontract-reconcile
-Version: 0.10.1rc1188
+Version: 0.10.1rc1189
 Summary: Collection of tools to reconcile services with their desired state as defined in the app-interface DB.
 Home-page: https://github.com/app-sre/qontract-reconcile
 Author: Red Hat App-SRE Team

{qontract_reconcile-0.10.1rc1188.dist-info → qontract_reconcile-0.10.1rc1189.dist-info}/RECORD

@@ -196,13 +196,13 @@ reconcile/external_resources/aws.py,sha256=EN2Vz6IRp6TNWX5vwGAGESrD09_8sTFzKgZjd
 reconcile/external_resources/factories.py,sha256=KrJDh52_8PeCEVjwfeVr1jwAJDdhMXRQ_XcBETfnKY4,4988
 reconcile/external_resources/integration.py,sha256=gBVO5dE8JyZ3xYcYik-MTIp_18oU7_hpYc_oztyfElQ,6753
 reconcile/external_resources/integration_secrets_sync.py,sha256=dX09O3r6KURziUYYfiki10orNjOGVma-XojhVqd0ww4,1667
-reconcile/external_resources/manager.py,sha256=fXUm09w-9FRWYfJAwtV4_td1UHNLzdoGhWYpw5VR9jg,17757
+reconcile/external_resources/manager.py,sha256=M_duB1JjQ3xRghvErbmAAbb3mWCo4bFf_2LHqAJVK7E,14991
 reconcile/external_resources/meta.py,sha256=noaytFzmShpzLA_ebGh7wuP45mOfHIOnnoUxivjDa1I,672
-reconcile/external_resources/metrics.py,sha256=nMbyonGZEJDD1lYzpQY2eR9TNwvxYC4ZCcpi6wrExcM,1037
-reconcile/external_resources/model.py,sha256=H3elpiqehg_jACy28fGV5_77n8gKclVO77-7cfbaMNA,9178
+reconcile/external_resources/metrics.py,sha256=8MZgNtNZzIRSYTX97KEUIUTETZBhitULzWxbShGyMO8,3193
+reconcile/external_resources/model.py,sha256=HVbt2dUJSoIj4MTNlAJeweKp4L0Af0XaNZXoCER7nVw,10571
 reconcile/external_resources/reconciler.py,sha256=K9QvbQCIOCuOHnPIxQE_P_jFtrkF3dGo8d_cCCh08Ys,8973
 reconcile/external_resources/secrets_sync.py,sha256=fxzrNreggWJvASonIPUr3CB5M637M1ljZLZr6dct9xU,16329
-reconcile/external_resources/state.py,sha256=z086bnIUTOkzFmQvS9rSAhFsM3Aw_9PLKHBACJ-0tQc,9690
+reconcile/external_resources/state.py,sha256=7DBzVhIvYqeZWrWapmU_bXXftTQa_m-EOwJFVlIFnDw,9583
 reconcile/glitchtip/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/glitchtip/integration.py,sha256=XtewM9nfTPLnPSpYebP50GrveYOnhTvKNq3seSvL6u8,8343
 reconcile/glitchtip/reconciler.py,sha256=nUvDv7qG1ly0cA16MmlL6NV71yl1mJYLT2mui7lmi0Y,12402
@@ -882,8 +882,8 @@ tools/test/test_qontract_cli.py,sha256=iuzKbQ6ahinvjoQmQLBrG4shey0z-1rB6qCgS8T6d
 tools/test/test_saas_promotion_state.py,sha256=dy4kkSSAQ7bC0Xp2CociETGN-2aABEfL6FU5D9Jl00Y,6056
 tools/test/test_sd_app_sre_alert_report.py,sha256=v363r9zM7__0kR5K6mvJoGFcM9BvE33fWAayrqkpojA,2116
 tools/test/test_sre_checkpoints.py,sha256=SKqPPTl9ua0RFdSSofnoQX-JZE6dFLO3LRhfQzqtfh8,2607
-qontract_reconcile-0.10.1rc1188.dist-info/METADATA,sha256=GT_x8-c5VlD7dIrPKFWAaFfVJawtfVTFoiH22w4G4Cw,2213
-qontract_reconcile-0.10.1rc1188.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-qontract_reconcile-0.10.1rc1188.dist-info/entry_points.txt,sha256=GKQqCl2j2X1BJQ69een6rHcR26PmnxnONLNOQB-nRjY,491
-qontract_reconcile-0.10.1rc1188.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
-qontract_reconcile-0.10.1rc1188.dist-info/RECORD,,
+qontract_reconcile-0.10.1rc1189.dist-info/METADATA,sha256=NVuBKGEqAXmlVCYwyO-M5Cnu8hcOq0-pJJ9g7a9JCro,2213
+qontract_reconcile-0.10.1rc1189.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+qontract_reconcile-0.10.1rc1189.dist-info/entry_points.txt,sha256=GKQqCl2j2X1BJQ69een6rHcR26PmnxnONLNOQB-nRjY,491
+qontract_reconcile-0.10.1rc1189.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
+qontract_reconcile-0.10.1rc1189.dist-info/RECORD,,

reconcile/external_resources/manager.py

@@ -1,9 +1,7 @@
 import logging
 from collections.abc import Iterable
 from datetime import UTC, datetime
-from enum import StrEnum
 
-from pydantic import BaseModel
 from sretoolbox.utils import threaded
 
 from reconcile.external_resources.factories import (
@@ -14,11 +12,7 @@ from reconcile.external_resources.factories import (
     TerraformModuleProvisionDataFactory,
     setup_aws_resource_factories,
 )
-from reconcile.external_resources.metrics import (
-    ExternalResourcesReconcileErrorsCounter,
-    ExternalResourcesReconcileTimeGauge,
-    ExternalResourcesResourceStatus,
-)
+from reconcile.external_resources.metrics import publish_metrics
 from reconcile.external_resources.model import (
     Action,
     ExternalResource,
@@ -27,11 +21,12 @@ from reconcile.external_resources.model import (
     ExternalResourcesInventory,
     ExternalResourceValidationError,
     ModuleInventory,
+    ReconcileAction,
     Reconciliation,
+    ReconciliationStatus,
 )
 from reconcile.external_resources.reconciler import (
     ExternalResourcesReconciler,
-    ReconciliationK8sJob,
 )
 from reconcile.external_resources.secrets_sync import InClusterSecretsReconciler
 from reconcile.external_resources.state import (
@@ -43,7 +38,6 @@ from reconcile.external_resources.state import (
 from reconcile.gql_definitions.external_resources.external_resources_settings import (
     ExternalResourcesSettingsV1,
 )
-from reconcile.utils import metrics
 from reconcile.utils.external_resource_spec import (
     ExternalResourceSpec,
 )
@@ -78,67 +72,6 @@ def setup_factories(
     return of
 
 
-class ReconcileAction(StrEnum):
-    NOOP = "NOOP"
-    APPLY_NOT_EXISTS = "Resource does not exist"
-    APPLY_ERROR = "Resource status in ERROR state"
-    APPLY_SPEC_CHANGED = "Resource spec has changed"
-    APPLY_DRIFT_DETECTION = "Resource drift detection run"
-    APPLY_USER_REQUESTED = "Resource reconciliation requested"
-    DESTROY_CREATED = "Resource no longer exists in the configuration"
-    DESTROY_ERROR = "Resource status in ERROR state"
-
-
-class ReconciliationStatus(BaseModel):
-    reconcile_time: int = 0
-    resource_status: ResourceStatus
-
-    def publish_metrics(self, r: Reconciliation, spec: ExternalResourceSpec) -> None:
-        job_name = ReconciliationK8sJob(reconciliation=r).name()
-
-        # Use transactional_metrics to remove old status, we just want to expose the latest status
-        with metrics.transactional_metrics(scope=job_name) as metrics_container:
-            metrics_container.set_gauge(
-                ExternalResourcesResourceStatus(
-                    app=spec.namespace["app"]["name"],
-                    environment=spec.namespace["environment"]["name"],
-                    provision_provider=r.key.provision_provider,
-                    provisioner_name=r.key.provisioner_name,
-                    provider=r.key.provider,
-                    identifier=r.key.identifier,
-                    job_name=job_name,
-                    status=self.resource_status,
-                ),
-                1,
-            )
-
-        metrics.set_gauge(
-            ExternalResourcesReconcileTimeGauge(
-                app=spec.namespace["app"]["name"],
-                environment=spec.namespace["environment"]["name"],
-                provision_provider=r.key.provision_provider,
-                provisioner_name=r.key.provisioner_name,
-                provider=r.key.provider,
-                identifier=r.key.identifier,
-                job_name=job_name,
-            ),
-            self.reconcile_time,
-        )
-
-        if self.resource_status.has_errors:
-            metrics.inc_counter(
-                ExternalResourcesReconcileErrorsCounter(
-                    app=spec.namespace["app"]["name"],
-                    environment=spec.namespace["environment"]["name"],
-                    provision_provider=r.key.provision_provider,
-                    provisioner_name=r.key.provisioner_name,
-                    provider=r.key.provider,
-                    identifier=r.key.identifier,
-                    job_name=job_name,
-                )
-            )
-
-
 class ExternalResourcesManager:
     def __init__(
         self,
@@ -276,9 +209,12 @@ class ExternalResourcesManager:
         :return: ReconciliationStatus
         """
 
-        status = ReconciliationStatus(resource_status=state.resource_status)
+        reconciliation_status = ReconciliationStatus(
+            resource_status=state.resource_status
+        )
+
         if not state.resource_status.is_in_progress:
-            return status
+            return reconciliation_status
 
         logging.info(
             "Reconciliation In progress. Action: %s, Key:%s",
@@ -286,10 +222,6 @@ class ExternalResourcesManager:
             state.reconciliation.key,
         )
 
-        # Need to check the reconciliation set in the state, not the desired one
-        # as the reconciliation object might be from a previous desired state
-        status.resource_status = state.resource_status
-
         match self.reconciler.get_resource_reconcile_status(state.reconciliation):
             case ReconcileStatus.SUCCESS:
                 logging.info(
@@ -298,10 +230,12 @@ class ExternalResourcesManager:
                     r.key,
                 )
                 if r.action == Action.APPLY:
-                    status.resource_status = ResourceStatus.PENDING_SECRET_SYNC
+                    reconciliation_status.resource_status = (
+                        ResourceStatus.PENDING_SECRET_SYNC
+                    )
                 elif r.action == Action.DESTROY:
-                    status.resource_status = ResourceStatus.DELETED
-                status.reconcile_time = (
+                    reconciliation_status.resource_status = ResourceStatus.DELETED
+                reconciliation_status.reconcile_time = (
                     self.reconciler.get_resource_reconcile_duration(r) or 0
                 )
             case ReconcileStatus.ERROR:
@@ -310,16 +244,18 @@ class ExternalResourcesManager:
                     r.action.value,
                     r.key,
                 )
-                status.resource_status = ResourceStatus.ERROR
+                reconciliation_status.resource_status = ResourceStatus.ERROR
             case ReconcileStatus.NOT_EXISTS:
                 logging.info(
                     "Reconciliation should exist but it doesn't. Marking as ERROR to retrigger: Action:%s, Key:%s",
                     r.action.value,
                     r.key,
                 )
-                status.resource_status = ResourceStatus.ERROR
+                reconciliation_status.resource_status = ResourceStatus.ERROR
+            case ReconcileStatus.IN_PROGRESS:
+                logging.debug("Reconciliation still in progress ...")
 
-        return status
+        return reconciliation_status
 
     def _update_resource_state(
         self,
@@ -327,19 +263,14 @@ class ExternalResourcesManager:
         state: ExternalResourceState,
         reconciliation_status: ReconciliationStatus,
     ) -> None:
-        if (
-            state.resource_status.is_in_progress
-            and reconciliation_status.resource_status.is_in_progress
-        ):
-            logging.debug(
-                "Reconciliation is still in progress. There is no need to update the state"
-            )
+        if not state.reconciliation_needs_state_update(reconciliation_status):
+            logging.debug("Reconciliation does not need a state update.")
             return
-        state.ts = datetime.now(UTC)
+
         if reconciliation_status.resource_status == ResourceStatus.DELETED:
             self.state_mgr.del_external_resource_state(r.key)
         else:
-            state.resource_status = reconciliation_status.resource_status
+            state.update_resource_status(reconciliation_status)
             self.state_mgr.set_external_resource_state(state)
 
     def _set_resource_reconciliation_in_progress(
@@ -414,7 +345,7 @@ class ExternalResourcesManager:
                 self._set_resource_reconciliation_in_progress(r, state)
 
             if spec := self.er_inventory.get(r.key):
-                reconciliation_status.publish_metrics(r, spec)
+                publish_metrics(r, spec, reconciliation_status)
 
         pending_sync_keys = self.state_mgr.get_keys_by_status(
             ResourceStatus.PENDING_SECRET_SYNC

reconcile/external_resources/metrics.py

@@ -1,6 +1,10 @@
 from pydantic import BaseModel
 
 from reconcile.external_resources.meta import QONTRACT_INTEGRATION
+from reconcile.external_resources.model import Reconciliation, ReconciliationStatus
+from reconcile.external_resources.reconciler import ReconciliationK8sJob
+from reconcile.utils import metrics
+from reconcile.utils.external_resources import ExternalResourceSpec
 from reconcile.utils.metrics import (
     CounterMetric,
     GaugeMetric,
@@ -39,3 +43,53 @@ class ExternalResourcesResourceStatus(ExternalResourcesBaseMetric, GaugeMetric):
     @classmethod
     def name(cls) -> str:
         return "external_resources_resource_status"
+
+
+def publish_metrics(
+    r: Reconciliation,
+    spec: ExternalResourceSpec,
+    reconciliation_status: ReconciliationStatus,
+) -> None:
+    job_name = ReconciliationK8sJob(reconciliation=r).name()
+
+    # Use transactional_metrics to remove old status, we just want to expose the latest status
+    with metrics.transactional_metrics(scope=job_name) as metrics_container:
+        metrics_container.set_gauge(
+            ExternalResourcesResourceStatus(
+                app=spec.namespace["app"]["name"],
+                environment=spec.namespace["environment"]["name"],
+                provision_provider=r.key.provision_provider,
+                provisioner_name=r.key.provisioner_name,
+                provider=r.key.provider,
+                identifier=r.key.identifier,
+                job_name=job_name,
+                status=reconciliation_status.resource_status,
+            ),
+            1,
+        )
+
+    metrics.set_gauge(
+        ExternalResourcesReconcileTimeGauge(
+            app=spec.namespace["app"]["name"],
+            environment=spec.namespace["environment"]["name"],
+            provision_provider=r.key.provision_provider,
+            provisioner_name=r.key.provisioner_name,
+            provider=r.key.provider,
+            identifier=r.key.identifier,
+            job_name=job_name,
+        ),
+        reconciliation_status.reconcile_time,
+    )
+
+    if reconciliation_status.resource_status.has_errors:
+        metrics.inc_counter(
+            ExternalResourcesReconcileErrorsCounter(
+                app=spec.namespace["app"]["name"],
+                environment=spec.namespace["environment"]["name"],
+                provision_provider=r.key.provision_provider,
+                provisioner_name=r.key.provisioner_name,
+                provider=r.key.provider,
+                identifier=r.key.identifier,
+                job_name=job_name,
+            )
+        )

reconcile/external_resources/model.py

@@ -245,6 +245,34 @@ class ExternalResourceModuleConfiguration(BaseModel, frozen=True):
         )
 
 
+class ResourceStatus(StrEnum):
+    CREATED: str = "CREATED"
+    DELETED: str = "DELETED"
+    ABANDONED: str = "ABANDONED"
+    NOT_EXISTS: str = "NOT_EXISTS"
+    IN_PROGRESS: str = "IN_PROGRESS"
+    DELETE_IN_PROGRESS: str = "DELETE_IN_PROGRESS"
+    ERROR: str = "ERROR"
+    PENDING_SECRET_SYNC: str = "PENDING_SECRET_SYNC"
+    RECONCILIATION_REQUESTED: str = "RECONCILIATION_REQUESTED"
+
+    @property
+    def does_not_exist(self) -> bool:
+        return self == ResourceStatus.NOT_EXISTS
+
+    @property
+    def is_in_progress(self) -> bool:
+        return self in {ResourceStatus.IN_PROGRESS, ResourceStatus.DELETE_IN_PROGRESS}
+
+    @property
+    def needs_secret_sync(self) -> bool:
+        return self == ResourceStatus.PENDING_SECRET_SYNC
+
+    @property
+    def has_errors(self) -> bool:
+        return self == ResourceStatus.ERROR
+
+
 class Reconciliation(BaseModel, frozen=True):
     key: ExternalResourceKey
     resource_hash: str = ""
@@ -255,6 +283,22 @@ class Reconciliation(BaseModel, frozen=True):
     )
 
 
+class ReconcileAction(StrEnum):
+    NOOP = "NOOP"
+    APPLY_NOT_EXISTS = "Resource does not exist"
+    APPLY_ERROR = "Resource status in ERROR state"
+    APPLY_SPEC_CHANGED = "Resource spec has changed"
+    APPLY_DRIFT_DETECTION = "Resource drift detection run"
+    APPLY_USER_REQUESTED = "Resource reconciliation requested"
+    DESTROY_CREATED = "Resource no longer exists in the configuration"
+    DESTROY_ERROR = "Resource status in ERROR state"
+
+
+class ReconciliationStatus(BaseModel):
+    reconcile_time: int = 0
+    resource_status: ResourceStatus
+
+
 class ModuleProvisionData(ABC, BaseModel):
     pass
 

reconcile/external_resources/state.py

@@ -10,6 +10,8 @@ from reconcile.external_resources.model import (
     ExternalResourceKey,
     ExternalResourceModuleConfiguration,
     Reconciliation,
+    ReconciliationStatus,
+    ResourceStatus,
 )
 from reconcile.utils.aws_api_typed.api import AWSApi
 
@@ -27,36 +29,26 @@ class ReconcileStatus(StrEnum):
     NOT_EXISTS: str = "NOT_EXISTS"
 
 
-class ResourceStatus(StrEnum):
-    CREATED: str = "CREATED"
-    DELETED: str = "DELETED"
-    ABANDONED: str = "ABANDONED"
-    NOT_EXISTS: str = "NOT_EXISTS"
-    IN_PROGRESS: str = "IN_PROGRESS"
-    DELETE_IN_PROGRESS: str = "DELETE_IN_PROGRESS"
-    ERROR: str = "ERROR"
-    PENDING_SECRET_SYNC: str = "PENDING_SECRET_SYNC"
-    RECONCILIATION_REQUESTED: str = "RECONCILIATION_REQUESTED"
-
-    @property
-    def is_in_progress(self) -> bool:
-        return self in {ResourceStatus.IN_PROGRESS, ResourceStatus.DELETE_IN_PROGRESS}
-
-    @property
-    def needs_secret_sync(self) -> bool:
-        return self == ResourceStatus.PENDING_SECRET_SYNC
-
-    @property
-    def has_errors(self) -> bool:
-        return self == ResourceStatus.ERROR
-
-
 class ExternalResourceState(BaseModel):
     key: ExternalResourceKey
     ts: datetime
     resource_status: ResourceStatus
     reconciliation: Reconciliation
 
+    def update_resource_status(
+        self, reconciliation_status: ReconciliationStatus
+    ) -> None:
+        if self.reconciliation_needs_state_update(reconciliation_status):
+            self.ts = datetime.now()
+            self.resource_status = reconciliation_status.resource_status
+
+    def reconciliation_needs_state_update(
+        self, reconciliation_status: ReconciliationStatus
+    ) -> bool:
+        return (
+            self.resource_status.is_in_progress or self.resource_status.does_not_exist
+        ) and not reconciliation_status.resource_status.is_in_progress
+
 
 class DynamoDBStateAdapter:
     # Table PK