Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit6d01552

Browse files
authored
Gitops sync timeout config (#918)
* Add sync timeout annotation* Add sync timeout configuration for appsAdded new sync timeout config for apps* Update content
1 parent6455eec commit6d01552

File tree

3 files changed

+41
-10
lines changed

3 files changed

+41
-10
lines changed

‎_docs/deployments/gitops/applications-dashboard.md‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,14 +167,24 @@ Applications with `rollout` resources need Argo Rollouts on the target cluster,
167167

168168

169169
###Warning: Long sync
170-
**Reason**: Ongoing sync for application exceeds 30 minutes (Argo CD's default duration for a sync operation).
170+
**Reason**: Ongoing sync for application exceeds the[configured timeout]({{site.baseurl}}/docs/deployments/gitops/manage-application/#configure-sync-timeout-for-argo-cd-applications).
171+
The Codefresh default is Argo CD's default duration of 30 minutes for a sync operation.
172+
173+
{% include
174+
image.html
175+
lightbox="true"
176+
file="/images/applications/app-sync-timeout-warning.png"
177+
url="/images/applications/app-sync-timeout-warning.png"
178+
alt="Example of sync timeout exceeded warning in**Warnings/Errors** panel"
179+
caption="Example of sync timeout exceeded warning in**Warnings/Errors** panel"
180+
max-width="60%"
181+
%}
171182

172183
**Corrective Action**:
173-
* Click**View Details** to take you directly to the Sync Result tab.
174-
Here you can see details on the sync job that was started, and info on the Hooks if any. Failed hooks are dsiplayed at the top.
175-
* To see more details such as the message and sync duration, switch to**Sync Info**.
176-
* To stop the sync operation, click**Terminate**.
177-
* Drill down into the application to investigate the issue and make changes.
184+
1. Click**View Details** to take you directly to the Sync Result tab.
185+
Here you can see details on the sync job that was started, and info on the Hooks if any. Failed hooks are displayed at the top.
186+
1. To see more details such as the message and sync duration, switch to**Sync Info**.
187+
1. Drill down into the application to investigate the issue and make changes.
178188

179189
##Monitor Argo CD application status in application header
180190
When you select an application from the Applications tab in the GitOps Apps dashboard, the application header, at the top of the page, displays critical information on the application, including health and sync statuses.

‎_docs/deployments/gitops/manage-application.md‎

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ There are two aspects to managing and optimizing Argo CD applications in Codefre
3535
*[Synchronize Argo CD applications](#manually-synchronize-an-argo-cd-application)
3636
Sync applications on-demand by manually applying sync options or by manually selecting the resources to sync.
3737

38+
*[Configure sync-timeout for Argo CD applications](#configure-sync-timeout-for-argo-cd-applications)
39+
Configure the sync-timeout through an annotation to be notified of long sync operations.
40+
3841
*[Terminate sync for Argo CD applications](#terminate-on-going-sync-for-argo-cd-applications)
3942
With a single-click, terminate on-going sync processes when needed.
4043

@@ -215,10 +218,6 @@ You can also synchronize _application resources_ with sync statuses such as `Ser
215218
***Out of sync**: Sync_only_ resources that are`Out of sync`.
216219

217220

218-
219-
220-
221-
222221
###Revision settings for application sync
223222
Revision settings determine the behavior for the branch you select.
224223

@@ -302,9 +301,31 @@ For example, if you made changes to `api` resources or `audit` resources, type `
302301
%}
303302

304303

304+
##Configure sync-timeout for Argo CD applications
305+
Add an annotation with the timeout threshold for the application to get notified when an ongoing sync exceeds the defined timeout.
306+
Codefresh uses Argo CD's default duration of 30 minutes which you can customize as needed.
307+
308+
Instead of waiting indefinitely for syncs to complete and then navigating through the GitOps Apps dashboard, get timely warnings from Codefresh.
305309

310+
* Add the following annotation to the application's YAML with the timeout you need:
311+
```yaml
312+
annotation:
313+
codefresh.io/app-sync-warning-threshold:"35"
314+
```
315+
Codefresh displays a warning in the **Warnings/Errors** button at the top right of the Applications tab in the GitOps Apps dashboard, when the sync duration exceeds the timeout specified.
316+
317+
{% include
318+
image.html
319+
lightbox="true"
320+
file="/images/applications/app-sync-timeout-warning.png"
321+
url="/images/applications/app-sync-timeout-warning.png"
322+
alt="Sync duration exceeded warning for application"
323+
caption="Sync duration exceeded warning for application"
324+
max-width="60%"
325+
%}
306326
307327
328+
You can view more [details on the sync]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/#warning-long-sync) or [terminate](#terminate-on-going-sync-for-argo-cd-applications) it.
308329
309330
## Terminate on-going sync for Argo CD applications
310331
Manually terminate an on-going synchronization process for the application. You may need to terminate an on-going sync that remains indefinitely as Syncing, or because you have detected problems in the current deployment
37.6 KB
Loading

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp