From d4b78a1e1de25f7b55f3a9b40958eae2dc2bf17a Mon Sep 17 00:00:00 2001 From: NimRegev Date: Sun, 20 Apr 2025 13:30:34 +0300 Subject: [PATCH 1/6] Add BYOA limitations table --- .../deployments/gitops/manage-application.md | 7 ++++++- .../gitops/monitor-applications.md | 4 +++- .../gitops/troubleshooting-gitops-apps.md | 14 ++++++++++++++ .../gitops/runtime-architecture.md | 5 +++-- .../runtime-install-with-existing-argo-cd.md | 19 +++++++++++++++++++ 5 files changed, 45 insertions(+), 4 deletions(-) diff --git a/_docs/deployments/gitops/manage-application.md b/_docs/deployments/gitops/manage-application.md index c5be9d436..bf6df12e0 100644 --- a/_docs/deployments/gitops/manage-application.md +++ b/_docs/deployments/gitops/manage-application.md @@ -707,8 +707,13 @@ Rename an Application Set and point all existing applications to the renamed App %} ## Enable precise sync detection for monorepo apps -Enable the ACR Controller in GitOps Runtimes to precisely detect sync operations that triggered deployments for applications in monorepo setups. +Enable the ACR (Application Change Revision) Controller in GitOps Runtimes to precisely detect sync operations that triggered deployments for applications in monorepo setups. +>**NOTE** +Not supported for GitOps Runtime installations with existing Argo CD. + + +ACR Controller When enabled, the ACR Controller: * Identifies and tracks application-specific changes by analyzing the application’s source path. * Compares revisions to identify the specific sync operation that triggered the promotion or deployment. diff --git a/_docs/deployments/gitops/monitor-applications.md b/_docs/deployments/gitops/monitor-applications.md index d98528aed..51d5c46d9 100644 --- a/_docs/deployments/gitops/monitor-applications.md +++ b/_docs/deployments/gitops/monitor-applications.md @@ -314,8 +314,10 @@ Use the `IgnoreExtraneous` filter to hide generated resources such as `ConfigMap The application remains in-sync even when such resources are syncing or out-of-sync. [Argo CD](https://argo-cd.readthedocs.io/en/stable/user-guide/compare-options){:target="\_blank"} + >**NOTE** -The `IgnoreExtraneous` filter when applied only affects sync status. +The `IgnoreExtraneous` filter is disabled for Runtime installations with existing Argo CD instances. +When applied, the `IgnoreExtraneous` filter only affects sync status. Degraded resources impact the health status of the application. ##### Add `IgnoreExtraneous` annotation diff --git a/_docs/deployments/gitops/troubleshooting-gitops-apps.md b/_docs/deployments/gitops/troubleshooting-gitops-apps.md index bbd825cba..7ce7345f7 100644 --- a/_docs/deployments/gitops/troubleshooting-gitops-apps.md +++ b/_docs/deployments/gitops/troubleshooting-gitops-apps.md @@ -76,3 +76,17 @@ time="2024-10-15T18:35:54Z" level=info msg="Patch operation sync result for appl 1. Send the logs collected to the Support team for further investigation. +## Filter by Kubernetes labels in Current State is disabled + +### Possible Causes +You have installed the GitOps Runtime with an existing Argo CD instance. +This filter option in the Current State tab is currently not supported. + +Stay tuned for updates on this feature. + +## Ignore Extraneous filter in the Current State tab is disabled + +### Possible Causes +You have installed the GitOps Runtime with an existing Argo CD instance. +This filter option in the Current State tab is currently not supported. + diff --git a/_docs/installation/gitops/runtime-architecture.md b/_docs/installation/gitops/runtime-architecture.md index c0674ee55..eba15aa7a 100644 --- a/_docs/installation/gitops/runtime-architecture.md +++ b/_docs/installation/gitops/runtime-architecture.md @@ -223,8 +223,9 @@ In monorepo environments where multiple applications share a single repository, * Ensures that notifications are scoped to the application that was actually modified, preventing unnecessary notifications for other applications within the same repository, improving clarity and reducing noise. >**NOTE** - The ACR Controller is supported from Runtime version 0.13.0 and higher. - It does not support multi-source applications. + The ACR Controller is supported from Runtime version 0.13.0 and higher for GitOps Runtime installations with new Argo CD. Not supported for installations with existing Argo CD. + It does not support multi-source applications. + ##### Configuration diff --git a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md index 357aca978..be2086ca5 100644 --- a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md +++ b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md @@ -240,6 +240,25 @@ Depending on your configuration, if you have private registries, you need to ove By default, the GitOps Runtime can deploy to the cluster it is installed on. You can add [Git Sources]({{site.baseurl}}/docs/installation/gitops/git-sources/), use [Terraform to connect external clusters]({{site.baseurl}}/docs/installation/gitops/managed-cluster/#add-a-managed-cluster-with-terraform), and [create and deploy Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/create-application/). + +## Limitations: GitOps Runtime with existing Argo CD + +The table below highlights the differences in features and functionality in GitOps Cloud for existing versus new Argo CD instances. +The table below outlines the current limitations and unsupported features when using GitOps Cloud with an existing (bring your own) Argo CD installation, compared to a new Argo CD (forked) installation. + +{: .table .table-bordered .table-hover} +| **Feature/Functionality**| **Behavior for existing Argo CD installation** | +| -------------- | ---------------- | +| **Multisource applications** | Applications with multiple sources are | +| **Sync detection for monorepo apps** | The ACR Controller which enables precise and accurate sync detections for applications from mono repositories is not supported. When using mono repos for applications with an existing Argo CD instance, this means that notifications are not aligned with the precise sync operations that triggered syncs for deployments. For details, see [Application Change Revision Controller]({{site.baseurl}}/docs/installation/gitops/runtime-architecture/). | +| **Application source and destination field verification** | When creating new Argo CD applications from the Codefresh UI, GitOps Cloud validates the Source and Destination URLs configured for the application. NIMA: so what is the current behavior iwth BYOA?
_Update pending_. | +|**Filter application resources by label** | Not supported. The filter by **Kubernetes labels** in More Filters in the Current State tab is disabled.
_Update pending_. | +|**Filter application by extraneous resources** | Not supported. The **Ignore Extraneous** button in the Current State tab is disabled. | +|**Multiple GitOps Runtimes and Argo CD instances on same cluster** | Not supported. Multiple GitOps Runtimes and Argo CD instances when separated by namespaces on the same cluster is not supported. | + + + + ## Related articles [Configuring GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/runtime-configuration/) [Upgrading GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/manage-runtimes/#upgrade-gitops-runtimes/) From 15cb3d998ea9b92e56546f6ab9bc3d1d3ed355d7 Mon Sep 17 00:00:00 2001 From: NimRegev Date: Mon, 21 Apr 2025 13:03:42 +0300 Subject: [PATCH 2/6] Update runtime-install-with-existing-argo-cd.md --- .../gitops/runtime-install-with-existing-argo-cd.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md index be2086ca5..fe19d731e 100644 --- a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md +++ b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md @@ -241,20 +241,19 @@ By default, the GitOps Runtime can deploy to the cluster it is installed on. You -## Limitations: GitOps Runtime with existing Argo CD +## Behavior notes: GitOps Runtime with existing Argo CD -The table below highlights the differences in features and functionality in GitOps Cloud for existing versus new Argo CD instances. -The table below outlines the current limitations and unsupported features when using GitOps Cloud with an existing (bring your own) Argo CD installation, compared to a new Argo CD (forked) installation. +The table below outlines the differences in features and functionality when using GitOps Cloud with an existing (bring your own) Argo CD installation, compared to a new Argo CD (forked) installation. {: .table .table-bordered .table-hover} | **Feature/Functionality**| **Behavior for existing Argo CD installation** | | -------------- | ---------------- | +|**Multiple GitOps Runtimes and Argo CD instances on same cluster** | Not supported. Multiple GitOps Runtimes and Argo CD instances when separated by namespaces on the same cluster is not supported. | | **Multisource applications** | Applications with multiple sources are | -| **Sync detection for monorepo apps** | The ACR Controller which enables precise and accurate sync detections for applications from mono repositories is not supported. When using mono repos for applications with an existing Argo CD instance, this means that notifications are not aligned with the precise sync operations that triggered syncs for deployments. For details, see [Application Change Revision Controller]({{site.baseurl}}/docs/installation/gitops/runtime-architecture/). | -| **Application source and destination field verification** | When creating new Argo CD applications from the Codefresh UI, GitOps Cloud validates the Source and Destination URLs configured for the application. NIMA: so what is the current behavior iwth BYOA?
_Update pending_. | +| **Sync detection for monorepo apps** | The Application Change Revision (ACR) Controller which enables precise and accurate sync detections for applications from mono repositories is not supported. When using mono repos for applications with an existing Argo CD instance, this means that notifications may not be not aligned with the precise sync operations that triggered syncs for deployments. For details, see [Application Change Revision Controller]({{site.baseurl}}/docs/installation/gitops/runtime-architecture/). | +| **Application source and destination field verification** | When creating new Argo CD applications from the Codefresh UI, GitOps Cloud does not validate the Source and Destination URLs configured for the application. This means that incorrect URLs are
_Update pending_. | |**Filter application resources by label** | Not supported. The filter by **Kubernetes labels** in More Filters in the Current State tab is disabled.
_Update pending_. | |**Filter application by extraneous resources** | Not supported. The **Ignore Extraneous** button in the Current State tab is disabled. | -|**Multiple GitOps Runtimes and Argo CD instances on same cluster** | Not supported. Multiple GitOps Runtimes and Argo CD instances when separated by namespaces on the same cluster is not supported. | From d693ceeb691198207d9f9583711f169b63e4e55e Mon Sep 17 00:00:00 2001 From: NimRegev Date: Sun, 27 Apr 2025 07:54:42 +0300 Subject: [PATCH 3/6] Update runtime-install-with-existing-argo-cd.md Removed limitation on multisource apps --- .../gitops/runtime-install-with-existing-argo-cd.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md index fe19d731e..6e9d719bc 100644 --- a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md +++ b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md @@ -243,13 +243,12 @@ By default, the GitOps Runtime can deploy to the cluster it is installed on. You ## Behavior notes: GitOps Runtime with existing Argo CD -The table below outlines the differences in features and functionality when using GitOps Cloud with an existing (bring your own) Argo CD installation, compared to a new Argo CD (forked) installation. +The table below outlines the differences in features and functionality when using GitOps Cloud with an existing (bring your own) Argo CD installation, compared to a new Argo CD (forked) installation. {: .table .table-bordered .table-hover} | **Feature/Functionality**| **Behavior for existing Argo CD installation** | | -------------- | ---------------- | |**Multiple GitOps Runtimes and Argo CD instances on same cluster** | Not supported. Multiple GitOps Runtimes and Argo CD instances when separated by namespaces on the same cluster is not supported. | -| **Multisource applications** | Applications with multiple sources are | | **Sync detection for monorepo apps** | The Application Change Revision (ACR) Controller which enables precise and accurate sync detections for applications from mono repositories is not supported. When using mono repos for applications with an existing Argo CD instance, this means that notifications may not be not aligned with the precise sync operations that triggered syncs for deployments. For details, see [Application Change Revision Controller]({{site.baseurl}}/docs/installation/gitops/runtime-architecture/). | | **Application source and destination field verification** | When creating new Argo CD applications from the Codefresh UI, GitOps Cloud does not validate the Source and Destination URLs configured for the application. This means that incorrect URLs are
_Update pending_. | |**Filter application resources by label** | Not supported. The filter by **Kubernetes labels** in More Filters in the Current State tab is disabled.
_Update pending_. | From a7bec5b561a8ad54714472c14ff7412c6f52e003 Mon Sep 17 00:00:00 2001 From: NimRegev Date: Mon, 28 Apr 2025 09:01:44 +0300 Subject: [PATCH 4/6] Update runtime-install-with-existing-argo-cd.md --- .../gitops/runtime-install-with-existing-argo-cd.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md index 6e9d719bc..6aad111ea 100644 --- a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md +++ b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md @@ -9,14 +9,16 @@ toc: true ## GitOps Runtime with existing Argo CD This article describes how to install GitOps Runtimes in a Codefresh account using a Helm chart on a _cluster that already has an Argo CD instance_. -This option allows you to install the GitOps Runtime without deploying a new Argo CD instance. Instead, you _install the GitOps Runtime in the same namespace as the existing Argo CD instance_. The Runtime authenticates with the Argo CD instance through the [Argo CD Admin API token]({{site.baseurl}}/docs/installation/gitops/runtime-argocd-admin-api-token/) which you need to provide, and connects to key Argo CD services. +This option allows you to install the GitOps Runtime without deploying a new Argo CD instance. Instead, you _install the GitOps Runtime in the same namespace as the existing Argo CD instance_. The Runtime authenticates with the Argo CD instance through the [Argo CD Admin API token]({{site.baseurl}}/docs/installation/gitops/runtime-argocd-admin-api-token/) which you need to provide, and connects to key Argo CD services. See also [notes on behavior for Runtimes with existing Argo CD](#gitops-runtime-with-existing-argo-cd-behavior). + +To install the _GitOps Runtime with a new Argo CD instance_, see [Install GitOps Runtime with new Argo CD]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/). + ##### Runtime values.yaml The Codefresh `values.yaml` available [here](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/values.yaml){:target="\_blank"}, contains all the arguments you can configure, including optional ones. Review how Codefresh [validates the Runtime's values.yaml]({{site.baseurl}}/docs/installation/gitops/gitops-values-yaml-validation/). -To install the GitOps Runtime with a new Argo CD instance, see [Install GitOps Runtime with new Argo CD]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/). ## Before you begin * Make sure you meet the [minimum requirements]({{site.baseurl}}/docs/installation/gitops/runtime-system-requirements/) for installation @@ -24,8 +26,6 @@ To install the GitOps Runtime with a new Argo CD instance, see [Install GitOps R * Verify you have a [valid Argo CD Admin API token]({{site.baseurl}}/docs/installation/gitops/runtime-argocd-admin-api-token/) - - ## Step 1: Select Runtime install option 1. On the Getting Started page, click **Install Runtime**. @@ -241,7 +241,7 @@ By default, the GitOps Runtime can deploy to the cluster it is installed on. You -## Behavior notes: GitOps Runtime with existing Argo CD +## GitOps Runtime with existing Argo CD behavior The table below outlines the differences in features and functionality when using GitOps Cloud with an existing (bring your own) Argo CD installation, compared to a new Argo CD (forked) installation. From 7e93e79e16934504f6a3636bc7a3a7af2784f4d4 Mon Sep 17 00:00:00 2001 From: NimRegev Date: Mon, 28 Apr 2025 09:26:46 +0300 Subject: [PATCH 5/6] Update runtime-install-with-existing-argo-cd.md --- .../gitops/runtime-install-with-existing-argo-cd.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md index 6aad111ea..696255bed 100644 --- a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md +++ b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md @@ -249,8 +249,8 @@ The table below outlines the differences in features and functionality when usin | **Feature/Functionality**| **Behavior for existing Argo CD installation** | | -------------- | ---------------- | |**Multiple GitOps Runtimes and Argo CD instances on same cluster** | Not supported. Multiple GitOps Runtimes and Argo CD instances when separated by namespaces on the same cluster is not supported. | -| **Sync detection for monorepo apps** | The Application Change Revision (ACR) Controller which enables precise and accurate sync detections for applications from mono repositories is not supported. When using mono repos for applications with an existing Argo CD instance, this means that notifications may not be not aligned with the precise sync operations that triggered syncs for deployments. For details, see [Application Change Revision Controller]({{site.baseurl}}/docs/installation/gitops/runtime-architecture/). | -| **Application source and destination field verification** | When creating new Argo CD applications from the Codefresh UI, GitOps Cloud does not validate the Source and Destination URLs configured for the application. This means that incorrect URLs are
_Update pending_. | +| **Sync detection for monorepo apps** | Not supported. The Application Change Revision (ACR) Controller which enables precise and accurate sync detections for applications from mono repositories is not supported. When using mono repos for applications with an existing Argo CD instance, this means that notifications may not be aligned with the precise sync operations that triggered syncs for deployments. For details, see [Application Change Revision Controller]({{site.baseurl}}/docs/installation/gitops/runtime-architecture/). | +| **Application source and destination URL validations** | When creating new Argo CD applications from the Codefresh UI, GitOps Cloud does not validate the Source and Destination URLs configured for the application. This means that incorrect URLs are saved and may cause application sync or deployment failures.
_Update pending_. | |**Filter application resources by label** | Not supported. The filter by **Kubernetes labels** in More Filters in the Current State tab is disabled.
_Update pending_. | |**Filter application by extraneous resources** | Not supported. The **Ignore Extraneous** button in the Current State tab is disabled. | From ab6eb431af861e88d7a5ae27b5a38723eba1b38b Mon Sep 17 00:00:00 2001 From: NimRegev Date: Mon, 28 Apr 2025 09:33:36 +0300 Subject: [PATCH 6/6] Update runtime-install-with-existing-argo-cd.md --- .../gitops/runtime-install-with-existing-argo-cd.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md index 696255bed..f9490e7ae 100644 --- a/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md +++ b/_docs/installation/gitops/runtime-install-with-existing-argo-cd.md @@ -248,11 +248,11 @@ The table below outlines the differences in features and functionality when usin {: .table .table-bordered .table-hover} | **Feature/Functionality**| **Behavior for existing Argo CD installation** | | -------------- | ---------------- | -|**Multiple GitOps Runtimes and Argo CD instances on same cluster** | Not supported. Multiple GitOps Runtimes and Argo CD instances when separated by namespaces on the same cluster is not supported. | -| **Sync detection for monorepo apps** | Not supported. The Application Change Revision (ACR) Controller which enables precise and accurate sync detections for applications from mono repositories is not supported. When using mono repos for applications with an existing Argo CD instance, this means that notifications may not be aligned with the precise sync operations that triggered syncs for deployments. For details, see [Application Change Revision Controller]({{site.baseurl}}/docs/installation/gitops/runtime-architecture/). | -| **Application source and destination URL validations** | When creating new Argo CD applications from the Codefresh UI, GitOps Cloud does not validate the Source and Destination URLs configured for the application. This means that incorrect URLs are saved and may cause application sync or deployment failures.
_Update pending_. | -|**Filter application resources by label** | Not supported. The filter by **Kubernetes labels** in More Filters in the Current State tab is disabled.
_Update pending_. | -|**Filter application by extraneous resources** | Not supported. The **Ignore Extraneous** button in the Current State tab is disabled. | +|**Multiple GitOps Runtimes and Argo CD instances on same cluster** | Not supported.
Multiple GitOps Runtimes and Argo CD instances when separated by namespaces on the same cluster is not supported. | +| **Sync detection for monorepo apps** | Not supported.
The Application Change Revision (ACR) Controller which enables precise and accurate sync detections for applications from mono repositories is not supported. When using mono repos for applications with an existing Argo CD instance, this means that notifications may not be aligned with the precise sync operations that triggered syncs for deployments. For details, see [Application Change Revision Controller]({{site.baseurl}}/docs/installation/gitops/runtime-architecture/). | +| **Application source and destination URL validations** | Not supported.
When creating new Argo CD applications from the Codefresh UI, GitOps Cloud does not validate the Source and Destination URLs configured for the application. This means that incorrect URLs are saved and may cause application sync or deployment failures.
_Update pending_. | +|**Filter application resources by label** | Not supported.
The filter by **Kubernetes labels** in More Filters in the Current State tab is disabled.
_Update pending_. | +|**Filter application by extraneous resources** | Not supported.
The **Ignore Extraneous** button in the Current State tab is disabled. |