qontract-reconcile 0.9.1rc292__py3-none-any.whl → 0.9.1rc294__py3-none-any.whl

{qontract_reconcile-0.9.1rc292.dist-info → qontract_reconcile-0.9.1rc294.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qontract-reconcile
-Version: 0.9.1rc292
+Version: 0.9.1rc294
 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.9.1rc292.dist-info → qontract_reconcile-0.9.1rc294.dist-info}/RECORD

@@ -179,6 +179,7 @@ reconcile/gql_definitions/common/app_interface_state_settings.py,sha256=-u159W10
 reconcile/gql_definitions/common/app_interface_vault_settings.py,sha256=GEjbO_R9qSWy-tyLoSR8P1usQ3QPA8kxIofd507xJzs,1789
 reconcile/gql_definitions/common/clusters.py,sha256=qr8gnFH71pYUGijReg0NvaQ7LF8u3pRvp1wG_8a43ig,24303
 reconcile/gql_definitions/common/clusters_minimal.py,sha256=iYnAPQ7jDtEu06XgkDlltXa2_iJsp56rIfDqEYef-uM,5257
+reconcile/gql_definitions/common/clusters_with_peering.py,sha256=HiAjIcKt9ojihIFXZmYX9ELZDqgpGIWPhmUpoiEEMZY,11985
 reconcile/gql_definitions/common/github_orgs.py,sha256=G73Oa0oMLpqhaxw23HA_fxoyO2VJOEJh4WSAAz3NF2Y,2043
 reconcile/gql_definitions/common/namespaces.py,sha256=HNu55aeBQUGr4JfjQFj8sGAE2SILh_TtTT6LmsHfwPo,9161
 reconcile/gql_definitions/common/namespaces_minimal.py,sha256=0n9f2ldd_aEN9tzcqKvtzZ53ceH-1v411vVkD8wPaeY,3539
@@ -267,12 +268,12 @@ reconcile/prometheus_rules_tester/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeR
 reconcile/prometheus_rules_tester/integration.py,sha256=Sn6mjzC2lJQVcETS1J2Z3tOwm8M3DDW-1GVT-5ccNuA,8860
 reconcile/saas_auto_promotions_manager/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/saas_auto_promotions_manager/integration.py,sha256=hmRWva3_ZEO845wMkttEt4X6Izl5p8ZKs09NXWp8mkY,5609
-reconcile/saas_auto_promotions_manager/publisher.py,sha256=gdzR7jNDKy130pO6J-UNwXI__EXgiREzdaXvNkE3Bhg,1845
-reconcile/saas_auto_promotions_manager/subscriber.py,sha256=XCXJh_Otr2H3dkIXt7AiTNwCi3mRsT4BsNz0xipCv_Y,6699
+reconcile/saas_auto_promotions_manager/publisher.py,sha256=Oi7QMlxY56NXO2W4NnB7kSeL-7Ef3oY75mIccoLWBwg,1980
+reconcile/saas_auto_promotions_manager/subscriber.py,sha256=8w9q1ceA2XnuTntThg8v6mE3K28aG2Y2DwQSuTudkns,6942
 reconcile/saas_auto_promotions_manager/merge_request_manager/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reconcile/saas_auto_promotions_manager/merge_request_manager/merge_request.py,sha256=diDb4BkErloZF6MfzQbMkqC1gx8tglYkw10Vuf_4_Ho,1147
-reconcile/saas_auto_promotions_manager/merge_request_manager/merge_request_manager.py,sha256=QVaaL0hQn0fy-NPmoKyJMp3NxNfE8umYjReaTztxCps,9763
-reconcile/saas_auto_promotions_manager/merge_request_manager/renderer.py,sha256=2_jZO2hhFZmX_YYOQTanTY7N4OrCQASIeM-ppGxkuvc,4637
+reconcile/saas_auto_promotions_manager/merge_request_manager/merge_request.py,sha256=PNu7sE-tDUY61E03z5w0b93fdowZ8auCl0S4_vhYOKQ,1333
+reconcile/saas_auto_promotions_manager/merge_request_manager/merge_request_manager.py,sha256=SNJ9WLlaFnf_tblwC0xDBfrXi4SVadeFgV3llhTqbGM,10959
+reconcile/saas_auto_promotions_manager/merge_request_manager/renderer.py,sha256=Ye3lmfWTbuHjMoCEOpGnGRK3QU0LwB_LVfnPXFdNxf4,4702
 reconcile/saas_auto_promotions_manager/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/saas_auto_promotions_manager/utils/saas_files_inventory.py,sha256=LEK_635Vt7VPWnhVonn54JxkfUKCehX3_6bJfD8zKbI,8597
 reconcile/saas_auto_promotions_manager/utils/vcs.py,sha256=wIB3DUazVpmysKuKmHZZ_yG9d04givRBulXrUuZyOgw,5240
@@ -434,6 +435,7 @@ reconcile/typed_queries/app_interface_state_settings.py,sha256=ytNAf3feg8JwmdCC4
 reconcile/typed_queries/app_interface_vault_settings.py,sha256=uFS7qLjjGnrK8gm2fkUT8RFd7s_5kxTWWpxZRhr1Ndo,746
 reconcile/typed_queries/clusters.py,sha256=mjEudUxMl0pqT0CIbDhgRONLQqfhTvDPS4SVyl0zIpM,393
 reconcile/typed_queries/clusters_minimal.py,sha256=MwFj2F_rqBFDI3sPbR4QbiME6HIYEPhrOyy07i_-oA8,409
+reconcile/typed_queries/clusters_with_peering.py,sha256=lIai7SJJD0bqIJbe7virgrbYRqjLouSL2OpJD0itpAY,330
 reconcile/typed_queries/github_orgs.py,sha256=UZhoPl8qvA_tcO7CZlN8GuMKckt3ywd47Suu61rgHsc,258
 reconcile/typed_queries/gitlab_instances.py,sha256=ZVQHy2W9xIp53f5qYkjKLHLHgOVtQpxTfcmM1C2046g,291
 reconcile/typed_queries/glitchtip_settings.py,sha256=Hwq8H73PTK-ZIysGEqWcPEqYyRjETS91h9odp-T5ce0,721
@@ -470,7 +472,7 @@ reconcile/utils/git_secrets.py,sha256=897nRs7tycA3m7YYeVEbzOhI8RFrI9IJT2E0di1eJh
 reconcile/utils/github_api.py,sha256=6gdlKK0W3vZpxbbtOcohRgvZ4YkiSki7Gxdb16goHPo,2316
 reconcile/utils/gitlab_api.py,sha256=Pl92DmudBEf6qRvfBs3T3x2psvrUxOPU5beupzW1ug8,24873
 reconcile/utils/gpg.py,sha256=EKG7_fdMv8BMlV5yUdPiqoTx-KrzmVSEAl2sLkaKwWI,1123
-reconcile/utils/gql.py,sha256=gs0prtFY_Jm_-o4Fobz4hmulW9NL6KYkcrCuyXIIn1s,11622
+reconcile/utils/gql.py,sha256=HcD8vYyX1reV1-7kNzszq6bWPJs7CvbNhPvBYwSE0pE,11655
 reconcile/utils/helm.py,sha256=IWlB_LrBK6ydwNQuZP2aMJGrtQw0lW7qdFqSrd3r8lg,1321
 reconcile/utils/helpers.py,sha256=rC6QwVBH40hLz6JrlNBB_UZfApaCrwgdjwlOFE_fG2M,371
 reconcile/utils/imap_client.py,sha256=byFAJATbITJPsGECSbvXBOcCnoeTUpDFiEjzOAxLm_U,1975
@@ -575,8 +577,8 @@ tools/sre_checkpoints/util.py,sha256=zEDbGr18ZeHNQwW8pUsr2JRjuXIPz--WAGJxZo9sv_Y
 tools/test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tools/test/test_qontract_cli.py,sha256=awwTHEc2DWlykuqGIYM0WOBoSL0KRnOraCLk3C7izis,1401
 tools/test/test_sre_checkpoints.py,sha256=SKqPPTl9ua0RFdSSofnoQX-JZE6dFLO3LRhfQzqtfh8,2607
-qontract_reconcile-0.9.1rc292.dist-info/METADATA,sha256=nRRiks-az7sMFQ04oizynlbvYPsNzLvgWAuOyv0EUL0,2287
-qontract_reconcile-0.9.1rc292.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-qontract_reconcile-0.9.1rc292.dist-info/entry_points.txt,sha256=aIVvB7OTCxYu0QkONzBPfFEyg68Pr8KUVKEEm4ChDVc,333
-qontract_reconcile-0.9.1rc292.dist-info/top_level.txt,sha256=j0CHPIc8TsVRB50wOz_jhxjjaRyCJB3NOQeXhuHS67c,34
-qontract_reconcile-0.9.1rc292.dist-info/RECORD,,
+qontract_reconcile-0.9.1rc294.dist-info/METADATA,sha256=em0hOB9rEHOy04LHmQ0cxqOb4VfdGQeLxCP_Ez88aQw,2287
+qontract_reconcile-0.9.1rc294.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+qontract_reconcile-0.9.1rc294.dist-info/entry_points.txt,sha256=aIVvB7OTCxYu0QkONzBPfFEyg68Pr8KUVKEEm4ChDVc,333
+qontract_reconcile-0.9.1rc294.dist-info/top_level.txt,sha256=j0CHPIc8TsVRB50wOz_jhxjjaRyCJB3NOQeXhuHS67c,34
+qontract_reconcile-0.9.1rc294.dist-info/RECORD,,

reconcile/gql_definitions/common/clusters_with_peering.py

@@ -0,0 +1,393 @@
+"""
+Generated by qenerate plugin=pydantic_v1. DO NOT MODIFY MANUALLY!
+"""
+from collections.abc import Callable  # noqa: F401 # pylint: disable=W0611
+from datetime import datetime  # noqa: F401 # pylint: disable=W0611
+from enum import Enum  # noqa: F401 # pylint: disable=W0611
+from typing import (  # noqa: F401 # pylint: disable=W0611
+    Any,
+    Optional,
+    Union,
+)
+
+from pydantic import (  # noqa: F401 # pylint: disable=W0611
+    BaseModel,
+    Extra,
+    Field,
+    Json,
+)
+
+from reconcile.gql_definitions.fragments.aws_infra_management_account import (
+    AWSInfrastructureManagementAccount,
+)
+from reconcile.gql_definitions.fragments.ocm_environment import OCMEnvironment
+from reconcile.gql_definitions.fragments.vault_secret import VaultSecret
+
+
+DEFINITION = """
+fragment AWSInfrastructureManagementAccount on AWSInfrastructureManagementAccount_v1 {
+  account {
+    name
+    uid
+    terraformUsername
+    resourcesDefaultRegion
+    automationToken {
+      ... VaultSecret
+    }
+  }
+  accessLevel
+  default
+}
+
+fragment OCMEnvironment on OpenShiftClusterManagerEnvironment_v1 {
+    name
+    url
+    accessTokenClientId
+    accessTokenUrl
+    accessTokenClientSecret {
+        ... VaultSecret
+    }
+}
+
+fragment VaultSecret on VaultSecret_v1 {
+    path
+    field
+    version
+    format
+}
+
+query ClustersWithPeering {
+  clusters: clusters_v1
+  {
+    path
+    name
+    ocm {
+      name
+      environment {
+        ... OCMEnvironment
+      }
+      orgId
+      accessTokenClientId
+      accessTokenUrl
+      accessTokenClientSecret {
+        ... VaultSecret
+      }
+      blockedVersions
+    }
+    awsInfrastructureManagementAccounts {
+      ... AWSInfrastructureManagementAccount
+    }
+
+    spec {
+      region
+    }
+    network {
+      vpc
+    }
+    peering {
+      connections {
+        name
+        provider
+        manageRoutes
+        delete
+        ... on ClusterPeeringConnectionAccount_v1 {
+          vpc {
+            account {
+              name
+              uid
+              terraformUsername
+              automationToken {
+                ... VaultSecret
+              }
+            }
+            vpc_id
+            cidr_block
+            region
+          }
+          assumeRole
+          manageAccountRoutes
+        }
+        ... on ClusterPeeringConnectionAccountVPCMesh_v1 {
+          account {
+            name
+            uid
+            terraformUsername
+            automationToken {
+              ... VaultSecret
+            }
+          }
+          tags
+        }
+        ... on ClusterPeeringConnectionAccountTGW_v1 {
+          account {
+            name
+            uid
+            terraformUsername
+            automationToken {
+              ... VaultSecret
+            }
+          }
+          tags
+          cidrBlock
+          manageSecurityGroups
+          manageRoute53Associations
+          assumeRole
+        }
+        ... on ClusterPeeringConnectionClusterRequester_v1 {
+          cluster {
+            name
+            network {
+              vpc
+            }
+            spec {
+              region
+            }
+            awsInfrastructureManagementAccounts {
+              ... AWSInfrastructureManagementAccount
+            }
+            peering {
+              connections {
+                name
+                provider
+                manageRoutes
+                ... on ClusterPeeringConnectionClusterAccepter_v1 {
+                  name
+                  cluster {
+                    name
+                  }
+                  awsInfrastructureManagementAccount {
+                    name
+                    uid
+                    terraformUsername
+                    automationToken {
+                      ... VaultSecret
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+    disable {
+      integrations
+    }
+  }
+}
+"""
+
+
+class ConfiguredBaseModel(BaseModel):
+    class Config:
+        smart_union = True
+        extra = Extra.forbid
+
+
+class OpenShiftClusterManagerV1(ConfiguredBaseModel):
+    name: str = Field(..., alias="name")
+    environment: OCMEnvironment = Field(..., alias="environment")
+    org_id: str = Field(..., alias="orgId")
+    access_token_client_id: Optional[str] = Field(..., alias="accessTokenClientId")
+    access_token_url: Optional[str] = Field(..., alias="accessTokenUrl")
+    access_token_client_secret: Optional[VaultSecret] = Field(
+        ..., alias="accessTokenClientSecret"
+    )
+    blocked_versions: Optional[list[str]] = Field(..., alias="blockedVersions")
+
+
+class ClusterSpecV1(ConfiguredBaseModel):
+    region: str = Field(..., alias="region")
+
+
+class ClusterNetworkV1(ConfiguredBaseModel):
+    vpc: str = Field(..., alias="vpc")
+
+
+class ClusterPeeringConnectionV1(ConfiguredBaseModel):
+    name: str = Field(..., alias="name")
+    provider: str = Field(..., alias="provider")
+    manage_routes: Optional[bool] = Field(..., alias="manageRoutes")
+    delete: Optional[bool] = Field(..., alias="delete")
+
+
+class AWSAccountV1(ConfiguredBaseModel):
+    name: str = Field(..., alias="name")
+    uid: str = Field(..., alias="uid")
+    terraform_username: Optional[str] = Field(..., alias="terraformUsername")
+    automation_token: VaultSecret = Field(..., alias="automationToken")
+
+
+class AWSVPCV1(ConfiguredBaseModel):
+    account: AWSAccountV1 = Field(..., alias="account")
+    vpc_id: str = Field(..., alias="vpc_id")
+    cidr_block: str = Field(..., alias="cidr_block")
+    region: str = Field(..., alias="region")
+
+
+class ClusterPeeringConnectionAccountV1(ClusterPeeringConnectionV1):
+    vpc: AWSVPCV1 = Field(..., alias="vpc")
+    assume_role: Optional[str] = Field(..., alias="assumeRole")
+    manage_account_routes: Optional[bool] = Field(..., alias="manageAccountRoutes")
+
+
+class ClusterPeeringConnectionAccountVPCMeshV1_AWSAccountV1(ConfiguredBaseModel):
+    name: str = Field(..., alias="name")
+    uid: str = Field(..., alias="uid")
+    terraform_username: Optional[str] = Field(..., alias="terraformUsername")
+    automation_token: VaultSecret = Field(..., alias="automationToken")
+
+
+class ClusterPeeringConnectionAccountVPCMeshV1(ClusterPeeringConnectionV1):
+    account: ClusterPeeringConnectionAccountVPCMeshV1_AWSAccountV1 = Field(
+        ..., alias="account"
+    )
+    tags: Optional[Json] = Field(..., alias="tags")
+
+
+class ClusterPeeringConnectionAccountTGWV1_AWSAccountV1(ConfiguredBaseModel):
+    name: str = Field(..., alias="name")
+    uid: str = Field(..., alias="uid")
+    terraform_username: Optional[str] = Field(..., alias="terraformUsername")
+    automation_token: VaultSecret = Field(..., alias="automationToken")
+
+
+class ClusterPeeringConnectionAccountTGWV1(ClusterPeeringConnectionV1):
+    account: ClusterPeeringConnectionAccountTGWV1_AWSAccountV1 = Field(
+        ..., alias="account"
+    )
+    tags: Optional[Json] = Field(..., alias="tags")
+    cidr_block: Optional[str] = Field(..., alias="cidrBlock")
+    manage_security_groups: Optional[bool] = Field(..., alias="manageSecurityGroups")
+    manage_route53_associations: Optional[bool] = Field(
+        ..., alias="manageRoute53Associations"
+    )
+    assume_role: Optional[str] = Field(..., alias="assumeRole")
+
+
+class ClusterPeeringConnectionClusterRequesterV1_ClusterV1_ClusterNetworkV1(
+    ConfiguredBaseModel
+):
+    vpc: str = Field(..., alias="vpc")
+
+
+class ClusterPeeringConnectionClusterRequesterV1_ClusterV1_ClusterSpecV1(
+    ConfiguredBaseModel
+):
+    region: str = Field(..., alias="region")
+
+
+class ClusterPeeringConnectionClusterRequesterV1_ClusterV1_ClusterPeeringV1_ClusterPeeringConnectionV1(
+    ConfiguredBaseModel
+):
+    name: str = Field(..., alias="name")
+    provider: str = Field(..., alias="provider")
+    manage_routes: Optional[bool] = Field(..., alias="manageRoutes")
+
+
+class ClusterPeeringConnectionClusterAccepterV1_ClusterV1(ConfiguredBaseModel):
+    name: str = Field(..., alias="name")
+
+
+class ClusterPeeringConnectionClusterAccepterV1_AWSAccountV1(ConfiguredBaseModel):
+    name: str = Field(..., alias="name")
+    uid: str = Field(..., alias="uid")
+    terraform_username: Optional[str] = Field(..., alias="terraformUsername")
+    automation_token: VaultSecret = Field(..., alias="automationToken")
+
+
+class ClusterPeeringConnectionClusterAccepterV1(
+    ClusterPeeringConnectionClusterRequesterV1_ClusterV1_ClusterPeeringV1_ClusterPeeringConnectionV1
+):
+    name: str = Field(..., alias="name")
+    cluster: ClusterPeeringConnectionClusterAccepterV1_ClusterV1 = Field(
+        ..., alias="cluster"
+    )
+    aws_infrastructure_management_account: Optional[
+        ClusterPeeringConnectionClusterAccepterV1_AWSAccountV1
+    ] = Field(..., alias="awsInfrastructureManagementAccount")
+
+
+class ClusterPeeringConnectionClusterRequesterV1_ClusterV1_ClusterPeeringV1(
+    ConfiguredBaseModel
+):
+    connections: list[
+        Union[
+            ClusterPeeringConnectionClusterAccepterV1,
+            ClusterPeeringConnectionClusterRequesterV1_ClusterV1_ClusterPeeringV1_ClusterPeeringConnectionV1,
+        ]
+    ] = Field(..., alias="connections")
+
+
+class ClusterPeeringConnectionClusterRequesterV1_ClusterV1(ConfiguredBaseModel):
+    name: str = Field(..., alias="name")
+    network: Optional[
+        ClusterPeeringConnectionClusterRequesterV1_ClusterV1_ClusterNetworkV1
+    ] = Field(..., alias="network")
+    spec: Optional[
+        ClusterPeeringConnectionClusterRequesterV1_ClusterV1_ClusterSpecV1
+    ] = Field(..., alias="spec")
+    aws_infrastructure_management_accounts: Optional[
+        list[AWSInfrastructureManagementAccount]
+    ] = Field(..., alias="awsInfrastructureManagementAccounts")
+    peering: Optional[
+        ClusterPeeringConnectionClusterRequesterV1_ClusterV1_ClusterPeeringV1
+    ] = Field(..., alias="peering")
+
+
+class ClusterPeeringConnectionClusterRequesterV1(ClusterPeeringConnectionV1):
+    cluster: ClusterPeeringConnectionClusterRequesterV1_ClusterV1 = Field(
+        ..., alias="cluster"
+    )
+
+
+class ClusterPeeringV1(ConfiguredBaseModel):
+    connections: list[
+        Union[
+            ClusterPeeringConnectionAccountTGWV1,
+            ClusterPeeringConnectionAccountV1,
+            ClusterPeeringConnectionAccountVPCMeshV1,
+            ClusterPeeringConnectionClusterRequesterV1,
+            ClusterPeeringConnectionV1,
+        ]
+    ] = Field(..., alias="connections")
+
+
+class DisableClusterAutomationsV1(ConfiguredBaseModel):
+    integrations: Optional[list[str]] = Field(..., alias="integrations")
+
+
+class ClusterV1(ConfiguredBaseModel):
+    path: str = Field(..., alias="path")
+    name: str = Field(..., alias="name")
+    ocm: Optional[OpenShiftClusterManagerV1] = Field(..., alias="ocm")
+    aws_infrastructure_management_accounts: Optional[
+        list[AWSInfrastructureManagementAccount]
+    ] = Field(..., alias="awsInfrastructureManagementAccounts")
+    spec: Optional[ClusterSpecV1] = Field(..., alias="spec")
+    network: Optional[ClusterNetworkV1] = Field(..., alias="network")
+    peering: Optional[ClusterPeeringV1] = Field(..., alias="peering")
+    disable: Optional[DisableClusterAutomationsV1] = Field(..., alias="disable")
+
+
+class ClustersWithPeeringQueryData(ConfiguredBaseModel):
+    clusters: Optional[list[ClusterV1]] = Field(..., alias="clusters")
+
+
+def query(query_func: Callable, **kwargs: Any) -> ClustersWithPeeringQueryData:
+    """
+    This is a convenience function which queries and parses the data into
+    concrete types. It should be compatible with most GQL clients.
+    You do not have to use it to consume the generated data classes.
+    Alternatively, you can also mime and alternate the behavior
+    of this function in the caller.
+
+    Parameters:
+        query_func (Callable): Function which queries your GQL Server
+        kwargs: optional arguments that will be passed to the query function
+
+    Returns:
+        ClustersWithPeeringQueryData: queried data parsed into generated classes
+    """
+    raw_data: dict[Any, Any] = query_func(DEFINITION, **kwargs)
+    return ClustersWithPeeringQueryData(**raw_data)

reconcile/saas_auto_promotions_manager/merge_request_manager/merge_request.py

@@ -9,6 +9,13 @@ LOG = logging.getLogger(__name__)
 
 
 class SAPMMR(MergeRequestBase):
+    """
+    Very thin wrapper around MergeRequestBase.
+    This class is not tested, thus logic in here
+    is kept to a minimum. Any rendering should
+    happen in renderer.py
+    """
+
     name = "SAPM"
 
     def __init__(

reconcile/saas_auto_promotions_manager/merge_request_manager/merge_request_manager.py

@@ -31,6 +31,22 @@ class OpenMergeRequest:
 
 
 class MergeRequestManager:
+    """
+    Manager for SAPM merge requests. This class
+    is responsible for housekeeping (closing old/bad MRs) and
+    opening new MRs for subscribers with a state diff.
+
+    The idea is that for every channel combination there exists
+    maximum one open MR in app-interface. I.e., all changes for
+    a channel combination are batched in a single MR. A content hash in the
+    description is used to identify the content of that MR. If a
+    channel combination receives new content before an already open MR
+    is merged, then the manager will first close the old MR and then
+    open a new MR with the new content. We might need to change this
+    batching approach in the future to have even less promotion MRs,
+    but for now this is sufficient.
+    """
+
     def __init__(self, vcs: VCS, renderer: Renderer):
         self._vcs = vcs
         self._renderer = renderer
@@ -57,6 +73,15 @@ class MergeRequestManager:
         ]
 
     def housekeeping(self) -> None:
+        """
+        Close bad MRs:
+        - bad description format
+        - old SAPM version
+        - merge conflict
+
+        --> if we bump the SAPM version, we automatically close
+        old open MRs and replace them with new ones.
+        """
         seen: set[tuple[str, str, str]] = set()
         for mr in self._open_raw_mrs:
             attrs = mr.attributes
@@ -177,6 +202,11 @@ class MergeRequestManager:
     def create_promotion_merge_requests(
         self, subscribers: Iterable[Subscriber]
     ) -> None:
+        """
+        Open new MR for channel combinations with new content.
+        If there is new content, close any existing MR for that
+        channel combination.
+        """
         subscribers_per_channel_combo = self._aggregate_subscribers_per_channel_combo(
             subscribers=subscribers
         )

reconcile/saas_auto_promotions_manager/merge_request_manager/renderer.py

@@ -19,13 +19,13 @@ This MR promotes all subscribers with auto-promotions for these channel(s).
 Please **do not remove the {SAPM_LABEL} label** from this MR.
 
 Parts of this description are used by SAPM to manage auto-promotions.
-
-Please **do not modify or alter this description**.
 """
 
 
 class Renderer:
     """
+    This class is only concerned with rendering text for MRs.
+    Most logic evolves around ruamel yaml modification.
     This class makes testing for MergeRequestManager easier.
     """
 

reconcile/saas_auto_promotions_manager/publisher.py

@@ -20,6 +20,11 @@ class DeploymentInfo:
 
 
 class Publisher:
+    """
+    Hold all information about a saas publisher target.
+    Contains logic to fetch the current state of a publisher.
+    """
+
     def __init__(
         self,
         ref: str,

reconcile/saas_auto_promotions_manager/subscriber.py

@@ -26,6 +26,11 @@ class ConfigHash:
 
 
 class Subscriber:
+    """
+    Hold all information about a saas subscriber target.
+    Contains logic to determine desired state.
+    """
+
     def __init__(
         self,
         saas_name: str,
@@ -52,7 +57,8 @@ class Subscriber:
             el for s in self.config_hashes_by_channel_name.values() for el in s
         }
         # We explicitly only care about subset - we do not care about
-        # dangling current hashses
+        # dangling current hashes - these are checked in saasherder
+        # MR validation function.
         desired_hashes_are_in_current_hashes = (
             set(self.desired_hashes) <= current_hashes
         )
@@ -156,7 +162,7 @@ class Subscriber:
     def combined_content_hash(subscribers: Iterable["Subscriber"]) -> str:
         """
         Get a deterministic content hash for the attributes of a collection
-        of subscribers.
+        of subscribers. The order of subscribers must not matter for the hash.
         It is important that this is a deterministic operation, because
         SAPM uses this hash to compare the content of MRs.
         """

reconcile/typed_queries/clusters_with_peering.py

@@ -0,0 +1,11 @@
+from reconcile.gql_definitions.common.clusters_with_peering import (
+    ClusterV1,
+    query,
+)
+from reconcile.utils.gql import GqlApi
+
+
+def get_clusters_with_peering(gql_api: GqlApi) -> list[ClusterV1]:
+    data = query(gql_api.query)
+    clusters = data.clusters or []
+    return [c for c in clusters if c.peering is not None]

reconcile/utils/gql.py

@@ -24,8 +24,6 @@ from sretoolbox.utils import retry
 from reconcile.status import RunningState
 from reconcile.utils.config import get_config
 
-_gqlapi = None
-
 INTEGRATIONS_QUERY = """
 {
     integrations: integrations_v1 {
@@ -221,6 +219,9 @@ class GqlApi:
         return None
 
 
+_gqlapi: Optional[GqlApi] = None
+
+
 def init(
     url: str,
     token: Optional[str] = None,
@@ -323,10 +324,10 @@ def _get_gql_server_and_token(
     return server, token, None, None
 
 
-def get_api():
+def get_api() -> GqlApi:
     global _gqlapi
 
-    if not _gqlapi:
+    if _gqlapi is None:
         raise GqlApiError("gql module has not been initialized.")
 
     return _gqlapi