Skip to content

Commit eefc519

Browse files
authored
Gitops byoa limitations (#1298)
* Add BYOA limitations table * Update runtime-install-with-existing-argo-cd.md * Update runtime-install-with-existing-argo-cd.md Removed limitation on multisource apps * Update runtime-install-with-existing-argo-cd.md * Update runtime-install-with-existing-argo-cd.md * Update runtime-install-with-existing-argo-cd.md
1 parent 4e917bb commit eefc519

File tree

5 files changed

+47
-8
lines changed

5 files changed

+47
-8
lines changed

_docs/deployments/gitops/manage-application.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -707,8 +707,13 @@ Rename an Application Set and point all existing applications to the renamed App
707707
%}
708708

709709
## Enable precise sync detection for monorepo apps
710-
Enable the ACR Controller in GitOps Runtimes to precisely detect sync operations that triggered deployments for applications in monorepo setups.
710+
Enable the ACR (Application Change Revision) Controller in GitOps Runtimes to precisely detect sync operations that triggered deployments for applications in monorepo setups.
711711

712+
>**NOTE**
713+
Not supported for GitOps Runtime installations with existing Argo CD.
714+
715+
716+
ACR Controller
712717
When enabled, the ACR Controller:
713718
* Identifies and tracks application-specific changes by analyzing the application’s source path.
714719
* Compares revisions to identify the specific sync operation that triggered the promotion or deployment.

_docs/deployments/gitops/monitor-applications.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -314,8 +314,10 @@ Use the `IgnoreExtraneous` filter to hide generated resources such as `ConfigMap
314314

315315
The application remains in-sync even when such resources are syncing or out-of-sync.
316316
[Argo CD](https://argo-cd.readthedocs.io/en/stable/user-guide/compare-options){:target="\_blank"}
317+
317318
>**NOTE**
318-
The `IgnoreExtraneous` filter when applied only affects sync status.
319+
The `IgnoreExtraneous` filter is disabled for Runtime installations with existing Argo CD instances.
320+
When applied, the `IgnoreExtraneous` filter only affects sync status.
319321
Degraded resources impact the health status of the application.
320322

321323
##### Add `IgnoreExtraneous` annotation

_docs/deployments/gitops/troubleshooting-gitops-apps.md

+14
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,17 @@ time="2024-10-15T18:35:54Z" level=info msg="Patch operation sync result for appl
7676
1. Send the logs collected to the Support team for further investigation.
7777

7878

79+
## Filter by Kubernetes labels in Current State is disabled
80+
81+
### Possible Causes
82+
You have installed the GitOps Runtime with an existing Argo CD instance.
83+
This filter option in the Current State tab is currently not supported.
84+
85+
Stay tuned for updates on this feature.
86+
87+
## Ignore Extraneous filter in the Current State tab is disabled
88+
89+
### Possible Causes
90+
You have installed the GitOps Runtime with an existing Argo CD instance.
91+
This filter option in the Current State tab is currently not supported.
92+

_docs/installation/gitops/runtime-architecture.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -223,8 +223,9 @@ In monorepo environments where multiple applications share a single repository,
223223
* 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.
224224

225225
>**NOTE**
226-
The ACR Controller is supported from Runtime version 0.13.0 and higher.
227-
It does not support multi-source applications.
226+
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.
227+
It does not support multi-source applications.
228+
228229

229230
##### Configuration
230231

_docs/installation/gitops/runtime-install-with-existing-argo-cd.md

+21-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ toc: true
99
## GitOps Runtime with existing Argo CD
1010
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_.
1111

12-
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.
12+
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).
13+
14+
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/).
15+
1316

1417
<iframe width="560" height="315" src="https://www.youtube.com/embed/vtCoi3-Rt6w?si=EqlKsiRtdIGcZLaX" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
1518

@@ -18,16 +21,13 @@ The Codefresh `values.yaml` available [here](https://github.com/codefresh-io/git
1821
Review how Codefresh [validates the Runtime's values.yaml]({{site.baseurl}}/docs/installation/gitops/gitops-values-yaml-validation/).
1922

2023

21-
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/).
2224

2325
## Before you begin
2426
* Make sure you meet the [minimum requirements]({{site.baseurl}}/docs/installation/gitops/runtime-system-requirements/) for installation
2527
* Verify that you complete all the [prerequisites]({{site.baseurl}}/docs/installation/gitops/runtime-prerequisites/)
2628
* Verify you have a [valid Argo CD Admin API token]({{site.baseurl}}/docs/installation/gitops/runtime-argocd-admin-api-token/)
2729

2830

29-
30-
3131
## Step 1: Select Runtime install option
3232

3333
1. On the Getting Started page, click **Install Runtime**.
@@ -242,6 +242,23 @@ Depending on your configuration, if you have private registries, you need to ove
242242
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/).
243243

244244

245+
246+
## GitOps Runtime with existing Argo CD behavior
247+
248+
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.
249+
250+
{: .table .table-bordered .table-hover}
251+
| **Feature/Functionality**| **Behavior for existing Argo CD installation** |
252+
| -------------- | ---------------- |
253+
|**Multiple GitOps Runtimes and Argo CD instances on same cluster** | Not supported. <br>Multiple GitOps Runtimes and Argo CD instances when separated by namespaces on the same cluster is not supported. |
254+
| **Sync detection for monorepo apps** | Not supported. <br> 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/). |
255+
| **Application source and destination URL validations** | Not supported. <br>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.<br>_Update pending_. |
256+
|**Filter application resources by label** | Not supported. <br>The filter by **Kubernetes labels** in More Filters in the Current State tab is disabled. <br>_Update pending_. |
257+
|**Filter application by extraneous resources** | Not supported.<br> The **Ignore Extraneous** button in the Current State tab is disabled. |
258+
259+
260+
261+
245262
## Related articles
246263
[Configuring GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/runtime-configuration/)
247264
[Upgrading GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/manage-runtimes/#upgrade-gitops-runtimes/)

0 commit comments

Comments
 (0)