diff --git a/_docs/deployment/applications-dashboard.md b/_docs/deployment/applications-dashboard.md index ba954625..1e960976 100644 --- a/_docs/deployment/applications-dashboard.md +++ b/_docs/deployment/applications-dashboard.md @@ -74,18 +74,51 @@ Here's a description of the information and actions in the Applications dashboar ### Identify applications with warnings/errors -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. +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. {% include image.html lightbox="true" -file="/images/applications/app-dashboard-errors.png" -url="/images/applications/app-dashboard-errors.png" -alt="Example of error notifications for applications" -caption="Example of error notifications for applications" -max-width="50%" +file="/images/applications/app-dashboard-warnings-errors.png" +url="/images/applications/app-dashboard-warnings-errors.png" +alt="Example of warning and error notifications for applications" +caption="Example of warning and error notifications for applications" +max-width="60%" %} +Every notification identifies: +* The type of resource with the problem (`Application`, `Deployment`, `Pod`) +* If it is health or sync related +* If it is a warning or error. + +All errors are Argo CD-generated errors. Codefresh generates custom warnings for the following: + +{::nomarkdown} +
+{:/} + +#### Warning: Missing Rollouts reporter in cluster + +**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. +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. + +**Corrective Action**: Click **Install** and install Argo Rollouts on the target cluster. + +{::nomarkdown} +
+{:/} + +#### Warning: Long sync +**Reason**: Ongoing sync for application exceeds 30 minutes (Argo CD's default duration for a sync operation). + +**Corrective Action**: +* Click **View Details** to take you directly to the Sync Result tab. + 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. +* To see more details such as the message and sync duration, switch to **Sync Info**. +* To stop the sync operation, click **Terminate**. +* Drill down into the application to investigate the issue and make changes. + + ### View deployment and configuration info for selected application 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%" 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"}. -You can view application resources in [List or Tree views](#view-modes-for-application-resources), and monitor: +You can view application resources in [List or Tree views](#view-modes-for-application-resources), [set filters](#filters-for-application-resources), and monitor: * [Health status](#health-status-for-application-resources) * [Sync status](#sync-status-for-application-resources) * [Manifests](#manifests-for-application-resources) @@ -299,7 +332,8 @@ caption="List view of application resources in Current State" max-width="50%" %} -> Filters are common to both Tree and List views, and when applied are retained when switching between views. + + ##### Working with resources in Tree view 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%" %} +#### Filters for application resources +Filters are common to both Tree and List views, and when applied are retained when switching between views. + +`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. + +>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. + +**For the `IgnoreExtraneous` filter to be effective:** + +* Add `IgnoreExtraneous` as an annotation to the resource, as in the example below of the `ConfigMap` resource. + +{% include +image.html +lightbox="true" +file="/images/applications/current-state-ignore-extraneous-annotation.png" +url="/images/applications/current-state-ignore-extraneous-annotation.png" +alt="Resource with IgnoreExtraneous annotation" +caption="Resource with IgnoreExtraneous annotation" +max-width="50%" +%} + +* In the Current State tab, click the `IgnoreExtraneous` filter. + You can see that the `IgnoreExtraneous` filter is active and the `ConfigMap` resource is not displayed in the Current State. + +{% include +image.html +lightbox="true" +file="/images/applications/current-state-ignore-extraneous-on.png" +url="/images/applications/current-state-ignore-extraneous-on.png" +alt="Current State filtered by IgnoreExtraneous resources" +caption="Current State filtered by IgnoreExtraneous resources" +max-width="50%" +%} + + #### Health status for application resources View and monitor health status of the selected application's resources in the Current State tab, in Tree or List views. 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 | **Degraded** | Resource is not healthy, or a timeout occurred before it could reach a healthy status.| {::nomarkdown}{:/} | | **Unknown** | Resource does not have a health status, or the health status is not tracked in Argo CD. For example,`ConfigMaps` resource types. | {::nomarkdown}{:/} | -See also [Argo CD's set of health checks](https://argo-cd.readthedocs.io/en/stable/operator-manual/health/). +See also [Argo CD's set of health checks](https://argo-cd.readthedocs.io/en/stable/operator-manual/health/){:target="\_blank"}. @@ -415,6 +484,8 @@ The table describes the possible sync statuses for an application resource, and | **Out-of-Sync** | {::nomarkdown}The live state is not identical to the desired state.
To sync a resource, select the Sync option from the resource's context menu in Tree view. {:/}| {::nomarkdown}{:/} | | **Unknown** | The sync status could not be determined. | {::nomarkdown}{:/} | +> 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. + The Application Warnings/Errors panel surfaces sync errors on exceeding the maximum number of retries and when a sync operation extends beyond 30 minutes. #### Manifests for application resources diff --git a/images/applications/app-dashboard-warnings-errors.png b/images/applications/app-dashboard-warnings-errors.png new file mode 100644 index 00000000..4868edbe Binary files /dev/null and b/images/applications/app-dashboard-warnings-errors.png differ diff --git a/images/applications/app-warnings-errors.png b/images/applications/app-warnings-errors.png new file mode 100644 index 00000000..4868edbe Binary files /dev/null and b/images/applications/app-warnings-errors.png differ diff --git a/images/applications/current-state-ignore-extraneous-annotation.png b/images/applications/current-state-ignore-extraneous-annotation.png new file mode 100644 index 00000000..cbce7a83 Binary files /dev/null and b/images/applications/current-state-ignore-extraneous-annotation.png differ diff --git a/images/applications/current-state-ignore-extraneous-off.png b/images/applications/current-state-ignore-extraneous-off.png new file mode 100644 index 00000000..9e52cab9 Binary files /dev/null and b/images/applications/current-state-ignore-extraneous-off.png differ diff --git a/images/applications/current-state-ignore-extraneous-on.png b/images/applications/current-state-ignore-extraneous-on.png new file mode 100644 index 00000000..0dbbc040 Binary files /dev/null and b/images/applications/current-state-ignore-extraneous-on.png differ