diff --git a/_data/home-content.yml b/_data/home-content.yml index f44b3461..8cf666a2 100644 --- a/_data/home-content.yml +++ b/_data/home-content.yml @@ -64,10 +64,12 @@ icon: images/home-icons/deployment.svg url: '' links: - - title: Applications dashboard - localurl: /docs/deployment/applications-dashboard/ - - title: Applications + - title: Creating applications localurl: /docs/deployment/create-application/ + - title: Monitoring applications + localurl: /docs/deployment/applications-dashboard/ + - title: Managing applications + localurl: /docs/deployment/manage-application/ - title: Images in Codefresh localurl: /docs/deployment/images/ - title: Install Argo Rollouts diff --git a/_data/nav.yml b/_data/nav.yml index 2bfef560..404a7e1d 100644 --- a/_data/nav.yml +++ b/_data/nav.yml @@ -81,10 +81,12 @@ - title: Deployment url: "/deployment" pages: - - title: Applications dashboard - url: "/applications-dashboard" - - title: Applications + - title: Creating applications url: "/create-application" + - title: Monitoring applications + url: "/applications-dashboard" + - title: Managing applications + url: "/manage-application" - title: Images in Codefresh url: "/images" - title: Install Argo Rollouts diff --git a/_docs/deployment/applications-dashboard.md b/_docs/deployment/applications-dashboard.md index b1fe144e..ba954625 100644 --- a/_docs/deployment/applications-dashboard.md +++ b/_docs/deployment/applications-dashboard.md @@ -1,171 +1,100 @@ --- -title: "Applications dashboard" +title: "Monitoring applications" description: "" group: deployment toc: true --- -View, monitor, and analyze deployments across your enterprise in the Applications dashboard. As a one-stop shop for Argo Rollouts and Argo CD in Codefresh, the Applications dashboard delivers on the challenge of keeping track of deployments, whatever the frequency and scale. A wide range of filters, enriched CI and CD information, provide full traceability and visibility to continuous deployments. +Monitor applications across clusters, and the deployments, resources, and services for an application in the Applications dashboard. As a one-stop shop for Argo Rollouts and Argo CD, the Applications dashboard in Codefresh delivers on the challenge of keeping track of your applications and their deployments, whatever the frequency and scale, across all clusters in your enterprise. A wide range of filters, progressive delivery views, and enriched CI and CD information, provide full traceability and visibility to your deployments. -Here are some insights you can derive from the Applications dashboard: -* Visibility into deployments from all the clusters associated with the provisioned runtimes, in-cluster and managed -* Timeline on current and historical deployments -* Enriched CI information for deployments, including links to container images, Git hashes correlated with feature requests, Jira issues -* Microservices deployed by the application -* Hierarchical view of the resources in the application in the Current State +Select the view format for the Applications Dashboard, as either [List or Card views](#select-view-mode-for-the-applications-dashboard). The default view displays all applications deployed within the last 30 days. Customize the scope through filters to display the [information](#applications-dashboard-information) you need. ->For information on creating, editing, and deleting applications, see [Applications in Codefresh]({{site.baseurl}}/docs/deployment/create-application/) - -### Applications main view - -The main view shows all deployed applications, sorted by the most recent deployments, by default. - - -Here is an example of the main page in the Applications dashboard. - - {% include +{% include image.html lightbox="true" file="/images/applications/app-dashboard-main-view.png" url="/images/applications/app-dashboard-main-view.png" -alt="Applications Dashboard" -caption="pplications Dashboard" -max-width="30%" -%} - -#### Error notifications -Errors in applications are flagged through the **Error Detected** button on the top right of the Applications dashboard. Clicking the button shows the list of applications with the errors and the possible reasons for those errors. - -{% include -image.html -lightbox="true" -file="/images/applications/app-dashboard-errors.png" -url="/images/applications/app-dashboard-errors.png" -alt="Error notifications in Applications Dashboard" -caption="Error notifications in Applications Dashboard" -max-width="50%" +alt="Applications Dashboard: List view" +caption="Applications Dashboard: List view" +max-width="60%" %} + +Monitor the current [health and sync status of applications](#identify-applications-with-warningserrors), and then select an application to drill down into its resources, deployments, and services: +* [View deployment and configuration info for selected application](#view-deployment-and-configuration-info-for-selected-application) +* [Monitor health and sync statuses for selected application](#monitor-health-and-sync-statuses-for-selected-application) +* [Monitor resources for selected application](#monitor-resources-for-selected-application) +* [Monitor deployments for selected application](#monitor-deployments-for-selected-application) +* [Monitor services for selected application](#monitor-services-for-selected-application) -#### Application inventory and state - -The application state snapshot shows at a glance both the total number of applications that are deployed and their breakdown according to state. - -> The state snapshot works also as a quick filter. Selecting a state filters the application view by that state. - -#### Filters and favorites -Similar to other dashboards, the Applications dashboard also offers a set of filters designed to bring you the information you need as quickly as possible. -You can also mark applications as favorites to focus on applications of interest. - -**Filters** - -Filters are divided into frequently used and advanced filters. -* Frequently-used filters: Available at the top of the dashboard. These filters support multi-selection, and results are based on an OR relationship within the same filter with multiple options, and an AND relationship between filters. -* Advanced filters: Available on selecting **More Filters**. These filters include application type, health, and labels. +>For information on creating and managing applications and application resources, see [Creating applications]({{site.baseurl}}/docs/deployment/create-application/) and [Managing applications]({{site.baseurl}}/docs/deployment/manage-application/). - * Application type - Applications and ApplicationSet - - * Health filters - The built-in Argo CD set of health filters. - For detailed information, see the official documentation on [Health sets](https://argo-cd.readthedocs.io/en/stable/operator-manual/health/){:target="\_blank"}. +### Select view mode for the Applications dashboard +View deployed applications in either List (the default) or Card views. Both views are sorted by the most recent deployments. - - * Labels - The K8s labels defined for the applications. The list displays labels of _all_ the applications, even if you have applied filters. +1. In the Codefresh UI, go to the [Applications dashboard](https://g.codefresh.io/2.0/applications-dashboard/list){:target="\_blank"}. +1. Select **List** or **Cards**. - To see the available labels, select **Add**, and then select the required label and one or more values. - To filter by the labels, select **Add** and then **Apply**. +#### Applications List view - For detailed information, see the official documentation on [Labels and selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/){:target="\_blank"}. +Here is an example of the Applications dashboard in List view mode. {% include image.html lightbox="true" -file="/images/applications/app-dashboard-adv-filters.png" -url="/images/applications/app-dashboard-adv-filters.png" -alt="Advanced filters in Applications Dashboard" -caption="Advanced filters in Applications Dashboard" -max-width="30%" -%} - - -**'Favorite' applications** - -Star applications as favorites, and view them with a click. -* Select the {::nomarkdown}{:/} to the left of the application name to mark it as a favorite. -* To view only favorites, on the filters bar, select {::nomarkdown}{:/}. - ->If you star applications as favorites, you can filter by the same applications in the [DORA metrics dashboard]({{site.baseurl}}/docs/reporting/dora-metrics/#metrics-for-favorite-applications). - - - -#### Deployment type -Applications are displayed according to their deployment type which can be one of the following: -* Applications +file="/images/applications/app-dashboard-main-view.png" +url="/images/applications/app-dashboard-main-view.png" +alt="Applications Dashboard: List view" +caption="Applications Dashboard: List view" +max-width="60%" +%} - Standalone applications. For detailed information, see the official documentation on [Applications](https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#applications){:target="\_blank"}. +#### Applications Card view +Here is an example of the Applications dashboard in Card view mode. The Card view provides a scannable view of application data and the actions to manage applications. {% include image.html lightbox="true" -file="/images/applications/apps-standalone.png" -url="/images/applications/apps-standalone.png" -alt="Standalone applications in Applications Dashboard" -caption="Standalone applications in Applications Dashboard" -max-width="30%" +file="/images/applications/app-dashboard-card-view.png" +url="/images/applications/app-dashboard-card-view.png" +alt="Applications Dashboard: Card view" +caption="Applications Dashboard: Card view" +max-width="60%" %} -* Application set - Based on the Argo CD's ApplicationSet CRD, where several applications are always deployed as a set. For detailed information, see the official documentation on [Generating Applications with ApplicationSet](https://argo-cd.readthedocs.io/en/stable/user-guide/application-set/){:target="\_blank"}. +### Applications dashboard information +Here's a description of the information and actions in the Applications dashboard. - {% include -image.html -lightbox="true" -file="/images/applications/app-appset-model.png" -url="/images/applications/app-appset-model.png" -alt="Application Set in Applications Dashboard" -caption="Application Set in Applications Dashboard" -max-width="30%" -%} - -* App-of-apps - In this deployment model, the parent application deploys a set of child applications. For detailed information, see the official documentation on [App of Apps](https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#app-of-apps){:target="\_blank"}. +{: .table .table-bordered .table-hover} +| Item | Description | +| -------------- | -------------- | +|Application filters | Filter by a range of attributes to customize the information in the dashboard to bring you what you need. {::nomarkdown} {:/}| +|{::nomarkdown}{:/}| Star applications as favorites and view only the starred applications.{::nomarkdown}
Select the to star the application as a favorite.

To filter by favorite applications, on the filters bar, select .
{:/} TIP: If you star applications as favorites in the Applications dashboard, you can filter by the same applications in the [DORA metrics dashboard]({{site.baseurl}}/docs/reporting/dora-metrics/#metrics-for-favorite-applications). | +|Application actions| Options to monitor/manage applications through the application's context menu. {::nomarkdown}