Skip to content

Commit 840246a

Browse files
authored
Update monitoring applications (#256)
* Update monitoring applications Added filter section with IgnoreExtraneous * Update monitoring apps Added new error/warnings and ignore extraneous * Update applications-dashboard.md * Update applications-dashboard.md * Update applications-dashboard.md
1 parent 9cbb8e3 commit 840246a

File tree

6 files changed

+80
-9
lines changed

6 files changed

+80
-9
lines changed

_docs/deployment/applications-dashboard.md

Lines changed: 80 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -74,18 +74,51 @@ Here's a description of the information and actions in the Applications dashboar
7474

7575

7676
### Identify applications with warnings/errors
77-
All applications with errors are flagged in the **Warnings/Errors** button, displayed at the top right of the Applications dashboard. Clicking the button shows the list of applications with the warnings/errors and the possible reasons for those errors.
77+
Errors are flagged in the **Warnings/Errors** button, displayed at the top right of the Applications dashboard. Clicking the button shows the list of applications with the warnings/errors and the possible reasons for these.
7878

7979
{% include
8080
image.html
8181
lightbox="true"
82-
file="/images/applications/app-dashboard-errors.png"
83-
url="/images/applications/app-dashboard-errors.png"
84-
alt="Example of error notifications for applications"
85-
caption="Example of error notifications for applications"
86-
max-width="50%"
82+
file="/images/applications/app-dashboard-warnings-errors.png"
83+
url="/images/applications/app-dashboard-warnings-errors.png"
84+
alt="Example of warning and error notifications for applications"
85+
caption="Example of warning and error notifications for applications"
86+
max-width="60%"
8787
%}
8888

89+
Every notification identifies:
90+
* The type of resource with the problem (`Application`, `Deployment`, `Pod`)
91+
* If it is health or sync related
92+
* If it is a warning or error.
93+
94+
All errors are Argo CD-generated errors. Codefresh generates custom warnings for the following:
95+
96+
{::nomarkdown}
97+
<br>
98+
{:/}
99+
100+
#### Warning: Missing Rollouts reporter in cluster
101+
102+
**Reason**: Codefresh has detected that Argo Rollouts is not installed on the target cluster. Rollout instructions are therefore not executed and the application is not deployed.
103+
Applications with `rollout` resources need Argo Rollouts on the target cluster, both to visualize rollouts in the Applications dashboard and control rollout steps with the Rollout Player.
104+
105+
**Corrective Action**: Click **Install** and install Argo Rollouts on the target cluster.
106+
107+
{::nomarkdown}
108+
<br>
109+
{:/}
110+
111+
#### Warning: Long sync
112+
**Reason**: Ongoing sync for application exceeds 30 minutes (Argo CD's default duration for a sync operation).
113+
114+
**Corrective Action**:
115+
* Click **View Details** to take you directly to the Sync Result tab.
116+
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.
117+
* To see more details such as the message and sync duration, switch to **Sync Info**.
118+
* To stop the sync operation, click **Terminate**.
119+
* Drill down into the application to investigate the issue and make changes.
120+
121+
89122
### View deployment and configuration info for selected application
90123

91124
View deployment, definition, and event information for the selected application in a centralized location through the Quick View.
@@ -259,7 +292,7 @@ max-width="50%"
259292

260293
The icon for a resource node identifies the type of Kubernetes resource it represents. For general information on K8s resources, see [Working with Kubernetes objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/){:target="\_blank"}.
261294

262-
You can view application resources in [List or Tree views](#view-modes-for-application-resources), and monitor:
295+
You can view application resources in [List or Tree views](#view-modes-for-application-resources), [set filters](#filters-for-application-resources), and monitor:
263296
* [Health status](#health-status-for-application-resources)
264297
* [Sync status](#sync-status-for-application-resources)
265298
* [Manifests](#manifests-for-application-resources)
@@ -299,7 +332,8 @@ caption="List view of application resources in Current State"
299332
max-width="50%"
300333
%}
301334

302-
> Filters are common to both Tree and List views, and when applied are retained when switching between views.
335+
336+
303337

304338
##### Working with resources in Tree view
305339
The Tree view is designed to impart key information at a glance. Review the sections that follow for pointers to quickly get to what you need in the Tree view.
@@ -381,6 +415,41 @@ max-width="50%"
381415
%}
382416

383417

418+
#### Filters for application resources
419+
Filters are common to both Tree and List views, and when applied are retained when switching between views.
420+
421+
`IgnoreExtraneous` is a filter in [Argo CD](https://argo-cd.readthedocs.io/en/stable/user-guide/compare-options){:target="\_blank"} that allows you to hide specific resources from the Current State views. These resources are usually generated by a tool and their sync statuses have no impact on the sync status of the application. For example, `ConfigMap` and `pods`. The application remains in-sync even when such resources are syncing or out-of-sync.
422+
423+
>The `IgnoreExtraneous` filter applies only to the sync status. The health status of the resource directly affects the application's health status. If the resource is degraded, then the application is also degraded.
424+
425+
**For the `IgnoreExtraneous` filter to be effective:**
426+
427+
* Add `IgnoreExtraneous` as an annotation to the resource, as in the example below of the `ConfigMap` resource.
428+
429+
{% include
430+
image.html
431+
lightbox="true"
432+
file="/images/applications/current-state-ignore-extraneous-annotation.png"
433+
url="/images/applications/current-state-ignore-extraneous-annotation.png"
434+
alt="Resource with IgnoreExtraneous annotation"
435+
caption="Resource with IgnoreExtraneous annotation"
436+
max-width="50%"
437+
%}
438+
439+
* In the Current State tab, click the `IgnoreExtraneous` filter.
440+
You can see that the `IgnoreExtraneous` filter is active and the `ConfigMap` resource is not displayed in the Current State.
441+
442+
{% include
443+
image.html
444+
lightbox="true"
445+
file="/images/applications/current-state-ignore-extraneous-on.png"
446+
url="/images/applications/current-state-ignore-extraneous-on.png"
447+
alt="Current State filtered by IgnoreExtraneous resources"
448+
caption="Current State filtered by IgnoreExtraneous resources"
449+
max-width="50%"
450+
%}
451+
452+
384453
#### Health status for application resources
385454
View and monitor health status of the selected application's resources in the Current State tab, in Tree or List views.
386455
Identify the health of an application resource through the color-coded border and the resource-type icon (Tree view), or the textual labels at the right of the resource (List view).
@@ -396,7 +465,7 @@ Identify the health of an application resource through the color-coded border an
396465
| **Degraded** | Resource is not healthy, or a timeout occurred before it could reach a healthy status.| {::nomarkdown}<img src="../../../images/icons/current-state-degraded.png" display=inline-block/>{:/} |
397466
| **Unknown** | Resource does not have a health status, or the health status is not tracked in Argo CD. For example,`ConfigMaps` resource types. | {::nomarkdown}<img src="../../../images/icons/current-state-unknown.png" display=inline-block">{:/} |
398467

399-
See also [Argo CD's set of health checks](https://argo-cd.readthedocs.io/en/stable/operator-manual/health/).
468+
See also [Argo CD's set of health checks](https://argo-cd.readthedocs.io/en/stable/operator-manual/health/){:target="\_blank"}.
400469

401470

402471

@@ -415,6 +484,8 @@ The table describes the possible sync statuses for an application resource, and
415484
| **Out-of-Sync** | {::nomarkdown}The live state is not identical to the desired state.<br>To sync a resource, select the <b>Sync</b> option from the resource's context menu in Tree view. {:/}| {::nomarkdown}<img src="../../../images/icons/current-state-out-of-sync.png" display=inline-block">{:/} |
416485
| **Unknown** | The sync status could not be determined. | {::nomarkdown}<img src="../../../images/icons/current-state-sync-unknown.png" display=inline-block">{:/} |
417486

487+
> The application header displays the statuses of the current and previous sync operations. Clicking **More** opens the Sync panels with Sync Info, Sync Result and Commit Info.
488+
The Application Warnings/Errors panel surfaces sync errors on exceeding the maximum number of retries and when a sync operation extends beyond 30 minutes.
418489

419490
#### Manifests for application resources
420491

182 KB
Loading
182 KB
Loading
156 KB
Loading
306 KB
Loading
295 KB
Loading

0 commit comments

Comments
 (0)