gitops 1.1.1__tar.gz → 1.2.0__tar.gz

gitops-1.2.0/.release-please-manifest.json

@@ -0,0 +1,5 @@
+{
+    ".": "1.2.0",
+    "gitops_server": "0.15.1",
+    "charts/gitops": "1.1.2"
+}

{gitops-1.1.1 → gitops-1.2.0}/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [1.2.0](https://github.com/uptick/gitops/compare/gitops-v1.1.2...gitops-v1.2.0) (2025-03-17)
+
+
+### Features
+
+* **cli:** allow filtering apps via a csv file ([f465d9a](https://github.com/uptick/gitops/commit/f465d9a8ad565afde1f9bf7f9d1232281352882c))
+* **cli:** allow filtering apps via a csv file ([7fa06cd](https://github.com/uptick/gitops/commit/7fa06cd6d8ca42a2d1e50304ad7cba7e688650e9))
+
+
+### Bug Fixes
+
+* remove status updater and replace with a post deploy hook ([e72c2ad](https://github.com/uptick/gitops/commit/e72c2ad2b46304f2258d7b3d1bb04e4200ce1602))
+
+## [1.1.2](https://github.com/uptick/gitops/compare/gitops-v1.1.1...gitops-v1.1.2) (2025-02-14)
+
+
+### Bug Fixes
+
+* **helm:** if a roll back is required; rollback before upgrading ([762cdb3](https://github.com/uptick/gitops/commit/762cdb388162c6b8645ec01f0d1c94c20d948b9f))
+
 ## [1.1.1](https://github.com/uptick/gitops/compare/gitops-v1.1.0...gitops-v1.1.1) (2025-01-24)
 
 

{gitops-1.1.1 → gitops-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitops
-Version: 1.1.1
+Version: 1.2.0
 Summary: Manage multiple apps across one or more k8s clusters.
 Author-email: Jarek Głowacki <jarekwg@gmail.com>
 License-File: LICENSE

{gitops-1.1.1 → gitops-1.2.0}/charts/gitops/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.1.2](https://github.com/uptick/gitops/compare/helm-v1.1.1...helm-v1.1.2) (2025-02-14)
+
+
+### Bug Fixes
+
+* remove gitops resource limits ([fcd9680](https://github.com/uptick/gitops/commit/fcd9680f6e94e5cb7a286c269aeaa1626c95a181))
+
 ## [1.1.1](https://github.com/uptick/gitops/compare/helm-v1.1.0...helm-v1.1.1) (2025-01-24)
 
 

{gitops-1.1.1 → gitops-1.2.0}/charts/gitops/Chart.yaml

@@ -2,4 +2,4 @@ apiVersion: v1
 appVersion: "1.0"
 description: GitOps Server Helm chart.
 name: gitops
-version: 1.1.1
+version: 1.1.2

{gitops-1.1.1 → gitops-1.2.0}/charts/gitops/templates/deployment.yml

@@ -40,8 +40,6 @@ spec:
         resources:
           requests:
             memory: "750Mi"
-          limits:
-            memory: "1500Mi"
 
         envFrom:
         - configMapRef:

{gitops-1.1.1 → gitops-1.2.0}/gitops/__init__.py

@@ -6,7 +6,7 @@ from gitops.utils.apps import App, get_app_details, get_apps
 
 from .utils.cli import success, warning
 
-__version__ = "1.1.1"
+__version__ = "1.2.0"
 
 
 # Checking gitops version matches cluster repo version.

{gitops-1.1.1 → gitops-1.2.0}/gitops/utils/apps.py

@@ -1,3 +1,4 @@
+import pathlib
 import sys
 from pathlib import Path
 from typing import Literal
@@ -77,6 +78,9 @@ def get_apps(  # noqa: C901
     `exclude`. The incoming filter and exclude params may come in as a list or commastring.
     For the purpose of this filtering, app names and image tag prefixes are also considered as
     tags. For instance, you can do get_apps(tags=[emeriss, production], exclude=[arafire]).
+
+    If filter is a file like name; read a list of app names from the file.
+
     Calling this method without any args returns all apps.
     There are three modes for communicating selected apps to the user:
     - PROMPT: Prints selected apps and asks for confirmation to proceed.
@@ -84,8 +88,13 @@ def get_apps(  # noqa: C901
     - SILENT: Proceeds without printing.
     Apps with the `inactive` tag are excluded by default, unless requested otherwise.
     """
+    app_names: list[str] = []
+
     if filter == "all":
         filter = set()
+    elif isinstance(filter, str) and pathlib.Path(filter).is_file():
+        app_names = [f.strip() for f in pathlib.Path(filter).read_text().splitlines() if f.strip()]
+        filter = set()
     else:
         filter = set(filter.split(",") if filter and isinstance(filter, str) else filter)
 
@@ -114,7 +123,12 @@ def get_apps(  # noqa: C901
 
         tags = set(app.tags + pseudotags)
         existing_tags |= tags
-        if filter <= tags and not exclude & tags:
+
+        # Decide whether to include the app based on the filter and exclude tags.
+        if app_names:
+            if app.name in app_names:
+                apps.append(app)
+        elif filter <= tags and not exclude & tags:
             apps.append(app)
 
     validate_tags(filter | exclude, existing_tags)

{gitops-1.1.1 → gitops-1.2.0}/gitops_server/main.py

@@ -13,7 +13,7 @@ from uptick_observability.logging import (  # type: ignore[import-untyped]
 
 from gitops_server import settings
 from gitops_server.app import app
-from gitops_server.workers import DeploymentStatusWorker, DeployQueueWorker
+from gitops_server.workers import DeployQueueWorker
 
 manually_instrument_logging()
 manually_instrument_fastapi()
@@ -64,9 +64,6 @@ async def startup_event():
     deploy_queue_worker = DeployQueueWorker.get_worker()
     deploy_queue_worker.task = asyncio.ensure_future(deploy_queue_worker.run(), loop=loop)
 
-    deployment_status_worker = DeploymentStatusWorker.get_worker()
-    deployment_status_worker.task = asyncio.ensure_future(deployment_status_worker.run(), loop=loop)
-
 
 def get_digest(data: bytes) -> str:
     """Calculate the digest of a webhook body.

gitops-1.2.0/gitops_server/version.py

@@ -0,0 +1 @@
+__version__ = "1.2.0"

gitops-1.2.0/gitops_server/workers/__init__.py

@@ -0,0 +1 @@
+from .deployer import DeployQueueWorker  # NOQA

{gitops-1.1.1 → gitops-1.2.0}/gitops_server/workers/deployer/deploy.py

@@ -11,7 +11,7 @@ from opentelemetry import trace
 
 from gitops.common.app import App
 from gitops_server import settings
-from gitops_server.types import AppDefinitions, UpdateAppResult
+from gitops_server.types import AppDefinitions, RunOutput, UpdateAppResult
 from gitops_server.utils import get_repo_name_from_url, github, run, slack
 from gitops_server.utils.git import temp_repo
 
@@ -133,6 +133,17 @@ class Deployer:
                 )
             return update_result
 
+    async def rollback_deployment(self, app: App) -> None:
+        with tracer.start_as_current_span("rollback_deployment", attributes={"app": app.name}):
+            logger.warning(
+                "Rolling back %s deployment due to previous failed helm install",
+                app.name,
+            )
+            await run(
+                f"helm rollback --namespace={app.namespace} {app.name}",
+                suppress_errors=True,
+            )
+
     async def update_app_deployment(self, app: App) -> UpdateAppResult | None:
         app.set_value("deployment.labels.gitops/deploy_id", self.deploy_id)
         app.set_value("deployment.labels.gitops/status", github.STATUSES.in_progress)
@@ -155,6 +166,40 @@ class Deployer:
                             os.fsync(cfg.fileno())
 
                             with tracer.start_as_current_span("helm_upgrade"):
+
+                                async def upgrade_helm_git() -> RunOutput:
+                                    result = await run(
+                                        "helm secrets upgrade --create-namespace"
+                                        f" --history-max {MAX_HELM_HISTORY}"
+                                        " --install"
+                                        " --timeout=600s"
+                                        f"{' --set skip_migrations=true' if self.skip_migrations else ''}"
+                                        f" -f {cfg.name}"
+                                        f" --namespace={app.namespace}"
+                                        f" {app.name}"
+                                        f" {chart_folder_path}",
+                                        suppress_errors=True,
+                                    )
+                                    return result
+
+                                result = await upgrade_helm_git()
+                                if result["exit_code"] != 0 and "is in progress" in result["output"]:
+                                    await self.rollback_deployment(app)
+                                    result = await upgrade_helm_git()
+
+                elif app.chart.type == "helm":
+                    span.set_attribute("gitops.chart.type", "helm")
+                    with tempfile.NamedTemporaryFile(suffix=".yml") as cfg:
+                        cfg.write(json.dumps(app.values).encode())
+                        cfg.flush()
+                        os.fsync(cfg.fileno())
+                        chart_version_arguments = f" --version={app.chart.version}" if app.chart.version else ""
+                        with tracer.start_as_current_span("helm_repo_add"):
+                            await run(f"helm repo add {app.chart.helm_repo} {app.chart.helm_repo_url}")
+
+                        with tracer.start_as_current_span("helm_upgrade"):
+
+                            async def upgrade_helm_chart() -> RunOutput:
                                 result = await run(
                                     "helm secrets upgrade --create-namespace"
                                     f" --history-max {MAX_HELM_HISTORY}"
@@ -164,32 +209,15 @@ class Deployer:
                                     f" -f {cfg.name}"
                                     f" --namespace={app.namespace}"
                                     f" {app.name}"
-                                    f" {chart_folder_path}",
+                                    f" {app.chart.helm_chart} {chart_version_arguments}",
                                     suppress_errors=True,
                                 )
-                elif app.chart.type == "helm":
-                    span.set_attribute("gitops.chart.type", "helm")
-                    with tempfile.NamedTemporaryFile(suffix=".yml") as cfg:
-                        cfg.write(json.dumps(app.values).encode())
-                        cfg.flush()
-                        os.fsync(cfg.fileno())
-                        chart_version_arguments = f" --version={app.chart.version}" if app.chart.version else ""
-                        with tracer.start_as_current_span("helm_repo_add"):
-                            await run(f"helm repo add {app.chart.helm_repo} {app.chart.helm_repo_url}")
+                                return result
 
-                        with tracer.start_as_current_span("helm_upgrade"):
-                            result = await run(
-                                "helm secrets upgrade --create-namespace"
-                                f" --history-max {MAX_HELM_HISTORY}"
-                                " --install"
-                                " --timeout=600s"
-                                f"{' --set skip_migrations=true' if self.skip_migrations else ''}"
-                                f" -f {cfg.name}"
-                                f" --namespace={app.namespace}"
-                                f" {app.name}"
-                                f" {app.chart.helm_chart} {chart_version_arguments}",
-                                suppress_errors=True,
-                            )
+                            result = await upgrade_helm_chart()
+                            if result["exit_code"] != 0 and "is in progress" in result["output"]:
+                                await self.rollback_deployment(app)
+                                result = await upgrade_helm_chart()
                 else:
                     logger.warning("Local is not implemented yet")
                     return None

{gitops-1.1.1 → gitops-1.2.0}/gitops_server/workers/deployer/hooks.py

@@ -50,10 +50,13 @@ async def update_issue_from_deployment_url(app: App, deployment_url: str, **kwar
 
 async def handle_successful_deploy(app: App, result, deployer, **kwargs) -> UpdateAppResult:
     github_deployment_url = str(app.values.get("github/deployment_url", ""))
+    # I know this shouldn't be uptick specific but for now it is.
+    environment_url = app.values.get("github/environment_url", "") or f"https://{app.name}.onuptick.com"
     await github.update_deployment(
         github_deployment_url,
-        status=github.STATUSES.in_progress,
+        status=github.STATUSES.success,
         description="Helm installed app into cluster. Waiting for pods to deploy.",
+        environment_url=environment_url,
     )
     return result
 

{gitops-1.1.1 → gitops-1.2.0}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "gitops"
-version = "1.1.1"
+version = "1.2.0"
 description = "Manage multiple apps across one or more k8s clusters."
 requires-python = ">=3.12"
 readme = "README.md"

{gitops-1.1.1 → gitops-1.2.0}/tests/test_gitops_server.py

@@ -31,14 +31,3 @@ def test_webhook_returns_200_if_hmac_is_correct():
 
         assert response.status_code == 200
         get_worker_mock.assert_called()
-
-
-@patch("gitops_server.main.settings.GITHUB_WEBHOOK_KEY", "test_key")
-def test_webhook_returns_400_if_hmac_is_invalid():
-    sha_encoding = "INVALID HMAC ENCODING"
-    headers["X-Hub-Signature"] = f"sha1={sha_encoding}"
-
-    with patch.object(gitops_server.workers.DeploymentStatusWorker, "get_worker", AsyncMock):
-        response = client.post("/webhook", headers=headers, json=payload)
-
-    assert response.status_code == 400

gitops-1.1.1/.release-please-manifest.json

@@ -1,5 +0,0 @@
-{
-    ".": "1.1.1",
-    "gitops_server": "0.15.1",
-    "charts/gitops": "1.1.1"
-}

gitops-1.1.1/gitops_server/version.py

@@ -1 +0,0 @@
-__version__ = "1.1.1"

gitops-1.1.1/gitops_server/workers/__init__.py

@@ -1,2 +0,0 @@
-from .deployer import DeployQueueWorker  # NOQA
-from .status_updater import DeploymentStatusWorker  # NOQA

gitops-1.1.1/gitops_server/workers/status_updater/__init__.py

@@ -1 +0,0 @@
-from .worker import DeploymentStatusWorker  # NOQA

gitops-1.1.1/gitops_server/workers/status_updater/worker.py

@@ -1,126 +0,0 @@
-"""
-This async worker keeps tracks of ongoing deployments by polling k8s space (CLUSTER_NAMESPACE).
-
-The worker polls and checks for deployments with the following labels:  gitops/deploy_id   and  gitops/status=in_progress
-
-Any failing/successfully deployed deployment is notified to github.
-This mechanism will only work if the annotation: github/deployment_url is applied to the deployment.
-
-TODO
-- Update the slack summary message from deploy.py
-- @notify the user if the deployment failed
-"""
-
-import asyncio
-import logging
-
-import kubernetes_asyncio  # type:ignore[import-untyped]
-import kubernetes_asyncio.client  # type:ignore[import-untyped]
-import kubernetes_asyncio.config  # type:ignore[import-untyped]
-
-from gitops_server.settings import CLUSTER_NAMESPACE
-from gitops_server.utils import github
-
-logger = logging.getLogger("deployment_status")
-
-
-async def get_ingress_url(api, namespace: str, app: str):
-    """Attempts to get domain for the ingress associated with the app"""
-    ingresses = await kubernetes_asyncio.client.NetworkingV1Api(api).list_namespaced_ingress(
-        namespace=namespace, label_selector=f"app={app}"
-    )
-    environment_url = ""
-    if ingresses.items:
-        try:
-            environment_url = "https://" + ingresses.items[0].spec.rules[0].host
-        except Exception:
-            logger.warning(f"Could not find ingress for {app=}")
-    return environment_url
-
-
-class DeploymentStatusWorker:
-    """Watches for deployments and updates the github deployment status"""
-
-    _worker = None
-
-    @classmethod
-    def get_worker(cls):
-        if not cls._worker:
-            loop = asyncio.get_running_loop()
-            cls._worker = cls(loop)
-        return cls._worker
-
-    def __init__(self, loop):
-        self.loop = loop
-
-    async def load_config(self):
-        try:
-            kubernetes_asyncio.config.load_incluster_config()
-        except kubernetes_asyncio.config.config_exception.ConfigException:
-            await kubernetes_asyncio.config.load_kube_config()
-
-    async def process_work(self):
-        await asyncio.sleep(5)
-        async with kubernetes_asyncio.client.ApiClient() as api:
-            apps_api = kubernetes_asyncio.client.AppsV1Api(api)
-            deployments = await apps_api.list_namespaced_deployment(
-                # Only things that have gitops/deploy_id aka was deployed
-                namespace=CLUSTER_NAMESPACE,
-                label_selector="gitops/deploy_id,gitops/status=in_progress",
-            )
-            await asyncio.sleep(5)
-
-            for deployment in deployments.items:
-                # Deployment status may not exist yet
-                if not deployment.status:
-                    continue
-                app = deployment.metadata.labels["app"]
-                namespace = deployment.metadata.namespace
-                github_deployment_url = deployment.metadata.annotations.get("github/deployment_url")
-                conds = {}
-                for x in deployment.status.conditions:
-                    conds[x.type] = x
-                status = None
-                if (
-                    len(conds) == 2
-                    and conds["Available"].status == "True"
-                    and conds["Progressing"].status == "True"
-                    and conds["Progressing"].reason == "NewReplicaSetAvailable"
-                ):
-                    status = github.STATUSES.success
-                    await github.update_deployment(
-                        github_deployment_url,
-                        status=status,
-                        description="Deployed successfully",
-                        environment_url=await get_ingress_url(api, namespace, app),
-                    )
-                elif (
-                    "Progressing" in conds
-                    and conds["Progressing"].status == "False"
-                    and conds["Progressing"].reason == "ProgressDeadlineExceeded"
-                ):
-                    status = github.STATUSES.failure
-                    await github.update_deployment(
-                        github_deployment_url,
-                        status=status,
-                        description="Failed to deploy. Check the pod or migrations.",
-                    )
-                if status:
-                    logger.info(f"Patching {deployment.metadata.name}.label.gitops/status to {status}")
-                    patch = {"metadata": {"labels": {"gitops/status": status}}}
-                    try:
-                        await apps_api.patch_namespaced_deployment(
-                            deployment.metadata.name, deployment.metadata.namespace, patch
-                        )
-                    except kubernetes_asyncio.client.exceptions.ApiException as e:
-                        logger.warning(e, exc_info=True)
-
-    async def run(self):
-        logger.info("Starting deployment status watching loop")
-        logger.info("Loading kubernetes asyncio api")
-        while True:
-            try:
-                await self.load_config()
-                await self.process_work()
-            except Exception as e:
-                logger.error(str(e), exc_info=True)