|
| 1 | +--- |
| 2 | +title:"Products dashboard" |
| 3 | +description:"" |
| 4 | +group:dashboards |
| 5 | +toc:true |
| 6 | +--- |
| 7 | + |
| 8 | +The Products dashboard is a way to view Argo CD applications in Codefresh |
| 9 | + |
| 10 | +Products are a way to group Argo CD applications in Codefresh, and the Products dashboard offers a unified view of these applications in across environments different environments. It offers cons |
| 11 | + |
| 12 | +How do you view applications by product? |
| 13 | +Create a product |
| 14 | + |
| 15 | +Connect an application to a product |
| 16 | + |
| 17 | +View information for product and its applications |
| 18 | + |
| 19 | +Dive into a unified view of app insights , all in the Products dashboard. |
| 20 | +Products connect your applications across different environments for streamlined management. |
| 21 | + |
| 22 | +##Argo CD applications & environments in Product |
| 23 | +Products to envitonments in that the show the applications connected to them by the environments in which thse applications are deployed. |
| 24 | + |
| 25 | +Products connect your applications across different environments for streamlined viewing and management. |
| 26 | + |
| 27 | +##Create products |
| 28 | +Create a product with a unique name and define the annotations by which to connect different Argo CD applications to a product. |
| 29 | + |
| 30 | +##Products dashboard |
| 31 | + |
| 32 | +Here's an example of the Products dashboard. |
| 33 | + TO BE CHANGED |
| 34 | +{% include |
| 35 | +image.html |
| 36 | +lightbox="true" |
| 37 | +file="/images/gitops-environments/environments-dashboard.png" |
| 38 | +url="/images/gitops-environments/environments-dashboard.png" |
| 39 | +alt="GitOps Environment dashboard" |
| 40 | +caption="GitOps Environment dashboard" |
| 41 | + max-width="60%" |
| 42 | +%} |
| 43 | + |
| 44 | +The table describes the information displayed in the Products dashboard. |
| 45 | + |
| 46 | +{: .table .table-bordered .table-hover} |
| 47 | +| Item| Description| |
| 48 | +| --------------| --------------| |
| 49 | +|**Filters**| Predefined filters that allow you to customize the Products dashboard view by Product Name, Application, or by Environment.| |
| 50 | +|**Default & expanded views**| . {::nomarkdown}<ul><li><b>Collapsed view</b>: The default view displays the product name alongside the environments with the number of applications in each environment. <br> <imgsrc="../../../../images/gitops-products/collapsed-view.png?display=inline-block"width="70%"></li><li><b>Expanded view</b>: The expanded view displays the applications by their environments. <br><imgsrc="../../../../images/gitops-products/expanded-view.png?display=inline-block"width="70%">.</li></ul>{:/}| |
| 51 | +|**Actions**| In both the collapsed and expanded views, mouse over the row with the product to see possible actions:{::nomarkdown}<ul><li><imgsrc="../../../../images/icons/edit.png?display=inline-block"> <b>Edit</b>: Edit the product's settings.</li><li><imgsrc="../../../../images/icons/settings.png?display=inline-block"> <b>Manage Applications</b>: Manually assign unassigned applications to environments in the Products dashboard. See <ahref="https://codefresh.io/docs/docs/deployments/gitops/gitops-products/#manually-assign-applications-to-products">Manually assign applications to products</a>.</li><li><imgsrc="../../../../images/icons/trash.png?display=inline-block"> <b>Delete</b>: Delete product from the Products dashboard. Deleting a product removes the product name from the Products dashboard, and unassigns the applications manually assigned to the product in the Products dashboard.</li></ul>{:/}| |
| 52 | + |
| 53 | +##Working with Products |
| 54 | + |
| 55 | +##Assign applications to products |
| 56 | +There are two ways to assign/connect an application to a Product: |
| 57 | +1. Products dashboard: Manually assign the application to the product through a single-click |
| 58 | +1. Application manifest: Add the product annotation to the application's manifest |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | + |
| 64 | +###Manually assign applications to products |
| 65 | +Manually assign an application to a product directly from the Products dashboard. This is an alternative to connecting an application to a product through an annotation in the application's manifest. |
| 66 | + |
| 67 | +Search for the application by the name of the application, cluster, or namespace mapped for the product. When assigned to a product, based on its defined environment, the application is automatically added to the column with the correct environment. |
| 68 | + |
| 69 | + |
| 70 | +1. In the Codefresh UI, from the Ops in the sidebar, select**Products**. |
| 71 | +1. Do one of the following: |
| 72 | +* Click the name of the product for which to assign applications, and then click**Manage Apps** on the top right. |
| 73 | +* Mouse over the row with the product name and click {::nomarkdown}<imgsrc="../../../../images/icons/trash.png?display=inline-block">{:/}. |
| 74 | + |
| 75 | +{% include |
| 76 | +image.html |
| 77 | +lightbox="true" |
| 78 | +file="/images/gitops-products/assign-apps-option.png" |
| 79 | +url="/images/gitops-products/assign-apps-option.png" |
| 80 | +alt="Option to assign applications to product" |
| 81 | +caption="Option to assign applications to product" |
| 82 | + max-width="60%" |
| 83 | +%} |
| 84 | + |
| 85 | +{:start="3"} |
| 86 | +1. Below the list of**Unassigned apps**, select the**Environment** by which to filter unassigned applications, or type a part of the application name in the search field. |
| 87 | + |
| 88 | +{% include |
| 89 | +image.html |
| 90 | +lightbox="true" |
| 91 | +file="/images/gitops-products/unassigned-apps-in-product.png" |
| 92 | +url="/images/gitops-products/unassigned-apps-in-product.png" |
| 93 | +alt="Unassigned applications in product" |
| 94 | +caption="Unassigned applications in product" |
| 95 | + max-width="60%" |
| 96 | +%} |
| 97 | + |
| 98 | +{:start="4"} |
| 99 | +1. To assign the application, click {::nomarkdown}<imgsrc="../../../../images/icons/runtime-topology-in-cluster.png?display=inline-block">{:/}. |
| 100 | +1. To confirm the assignment, click**Save**. |
| 101 | + The application is added to the environment defined for it. |
| 102 | + |
| 103 | +{% include |
| 104 | +image.html |
| 105 | +lightbox="true" |
| 106 | +file="/images/gitops-products/unassigned-apps-in-product.png" |
| 107 | +url="/images/gitops-products/unassigned-apps-in-product.png" |
| 108 | +alt="Unassigned applications in product" |
| 109 | +caption="Unassigned applications in product" |
| 110 | + max-width="60%" |
| 111 | +%} |
| 112 | + |
| 113 | + |
| 114 | +###Use annotations to connect applications to products |
| 115 | +Assign an application to a product by adding the default or custom annotation to the application's manifest. |
| 116 | +The annotation is the default or any custom annotation you defined for the product when you created it. |
| 117 | + |
| 118 | +1. In the Codefresh UI, from the Ops in the sidebar, select**Products**. |
| 119 | +1. Mouse over the row with the product name, and then click {::nomarkdown}<imgsrc="../../../../images/icons/edit.png?display=inline-block">{:/}. |
| 120 | +1. In the Edit Product form, copy the annotation to add to the application's manifest. |
| 121 | + |
| 122 | +{% include |
| 123 | +image.html |
| 124 | +lightbox="true" |
| 125 | +file="/images/gitops-products/unassigned-apps-in-product.png" |
| 126 | +url="/images/gitops-products/unassigned-apps-in-product.png" |
| 127 | +alt="Unassigned applications in product" |
| 128 | +caption="Unassigned applications in product" |
| 129 | + max-width="60%" |
| 130 | +%} |
| 131 | + |
| 132 | +{:start="4"} |
| 133 | +1. Expand the product. |
| 134 | +1. From the application's context menu, select**Edit**. |
| 135 | +1. In the**Configuration** tab, switch to the**YAML** format and add the annotation. |
| 136 | +1. Commit to save the changes. |
| 137 | + |
| 138 | +###Unassign an application from a Product |
| 139 | +Unassign an application from a Product directly from the Products dashboard. This is a quick option for applications manually assigned to Products from the Products dashboard. |
| 140 | + |
| 141 | +>**TIP:** |
| 142 | +If you used annotations to connect applications to Products, remove the annotation from the application manifest to unassign the application. |
| 143 | + |
| 144 | +1. In the Codefresh UI, from the Ops in the sidebar, select**Products**. |
| 145 | +1. Do one of the following: |
| 146 | +* Mouse over the row with the product from which to unassign the application. |
| 147 | +* Select the product with the application to unassign and click**Manage Apps**. |
| 148 | +1. In the card with the application to unassign, click {::nomarkdown}<imgsrc="../../../../images/icons/unassign-app.png?display=inline-block">{:/}. |
| 149 | + |
| 150 | +{% include |
| 151 | +image.html |
| 152 | +lightbox="true" |
| 153 | +file="/images/gitops-products/unassign-app-from-product.png" |
| 154 | +url="/images/gitops-products/unassign-app-from-product.png" |
| 155 | +alt="Unassign application from product" |
| 156 | +caption="Unassign application from product" |
| 157 | + max-width="60%" |
| 158 | +%} |
| 159 | + |
| 160 | + |
| 161 | +1. To confirm, click**Save**. |
| 162 | + The application reappears in the list of Unassigned applications. |
| 163 | + |
| 164 | +{% include |
| 165 | +image.html |
| 166 | +lightbox="true" |
| 167 | +file="/images/gitops-products/unassigned-app-example.png" |
| 168 | +url="/images/gitops-products/unassigned-app-example.png" |
| 169 | +alt="Unassigned application in list" |
| 170 | +caption="Unassigned application in list" |
| 171 | + max-width="60%" |
| 172 | +%} |
| 173 | + |
| 174 | +###Edit/delete Product |
| 175 | +Edit settings for an existing Product, or delete the Product from the Products dashboard. |
| 176 | + |
| 177 | +Edit all settings including the name of the product. |
| 178 | +Delete a product from the Products dashboard. Deleting a Product unassigns all the applications manually assigned to it in the Products dashboard. |
| 179 | +For applications connected through annotations in the manifests, the annotations are not deleted. |
| 180 | + |
| 181 | +1. In the Codefresh UI, from the Ops in the sidebar, select**Products**. |
| 182 | +1. From the Products dashboard, select the Product to edit or delete. |
| 183 | +1. From the context menu on the right, select the required option. |
| 184 | + |
| 185 | +{% include |
| 186 | +image.html |
| 187 | +lightbox="true" |
| 188 | +file="/images/gitops-products/edit-delete-product.png" |
| 189 | +url="/images/gitops-products/edit-delete-product.png" |
| 190 | +alt="Edit/delete Product" |
| 191 | +caption="Edit/delete Product" |
| 192 | + max-width="60%" |
| 193 | +%} |
| 194 | + |
| 195 | +{:start="4"} |
| 196 | +1. Edit settings or follow the instructions to delete the Product. |
| 197 | + |
| 198 | +##Work with applications in Products |
| 199 | + The actions to manage applications are similar to those available in the Environments dasboard. |
| 200 | + |
| 201 | +In addition, the Product das |
| 202 | + |
| 203 | +###Explore application views for products |
| 204 | +Switch between Kubernetes (Pods), version control (Git) and issue-tracking (Features) views of the applications assigned to the selected Product. |
| 205 | + |
| 206 | +####Pods |
| 207 | +Displays Deployment, Rollout, and Promotion information for the application: |
| 208 | +* Deployments: Source image, new image and tag, replicas for each deployment |
| 209 | +* Rollouts: Type of rollout, health, promote/pause rollout action |
| 210 | +* Promotion details: Reason, user who committed the change, and the commit hash |
| 211 | +* Cluster and namespace the application is deployed to |
| 212 | + |
| 213 | +{% include |
| 214 | +image.html |
| 215 | +lightbox="true" |
| 216 | +file="/images/gitops-products/pod-view-deployments.png" |
| 217 | +url="/images/gitops-products/pod-view-deployments.png" |
| 218 | +alt="Products: Pod view of application with Deployments" |
| 219 | +caption="Products: Pod view of application with Deployments" |
| 220 | + max-width="60%" |
| 221 | +%} |
| 222 | + |
| 223 | +{% include |
| 224 | +image.html |
| 225 | +lightbox="true" |
| 226 | +file="/images/gitops-products/pod-view-rollouts.png" |
| 227 | +url="/images/gitops-products/pod-view-rollouts.png" |
| 228 | +alt="Products: Pod view of application with Rollouts" |
| 229 | +caption="Products: Pod view of application with Rollouts" |
| 230 | + max-width="60%" |
| 231 | +%} |
| 232 | + |
| 233 | +####Git |
| 234 | +Displays version control information to track changes, code history, and collaboration, showing the evolution of the application's codebase: |
| 235 | +* Pull request history |
| 236 | +* Committer information |
| 237 | +* Commit message |
| 238 | +* Promotion information |
| 239 | +* Cluster and namespace the application is deployed to |
| 240 | + |
| 241 | +{% include |
| 242 | +image.html |
| 243 | +lightbox="true" |
| 244 | +file="/images/gitops-products/git-view.png" |
| 245 | +url="/images/gitops-products/git-view.png" |
| 246 | +alt="Products: Git view of application" |
| 247 | +caption="Products: Git view of application" |
| 248 | + max-width="60%" |
| 249 | +%} |
| 250 | + |
| 251 | +####Features |
| 252 | +Displays issue-tracking information that correlates software features with their deployment, showing which features are included in a release: |
| 253 | +* Bug/feature request and description |
| 254 | +* User to whom the bug/feature request is assigned |
| 255 | +* Status of the bug/feature request |
| 256 | +* Promotion information |
| 257 | +* Cluster and namespace the application is deployed to |
| 258 | + |
| 259 | +{% include |
| 260 | +image.html |
| 261 | +lightbox="true" |
| 262 | +file="/images/gitops-products/features-view.png" |
| 263 | +url="/images/gitops-products/features-view.png" |
| 264 | +alt="Products: Features view of application" |
| 265 | +caption="Products: Features view of application" |
| 266 | + max-width="60%" |
| 267 | +%} |
| 268 | + |
| 269 | +###Manage applications for products within environments |
| 270 | +Manage applications from within Products through the application's context menu, including manual sync, refresh, and other options. |
| 271 | + |
| 272 | +1. In the Codefresh UI, from the Ops in the sidebar, select**Products**. |
| 273 | +1. Select the Product with the application for which to take action. |
| 274 | +1. Click the context menu to the right of the application, and select the option: |
| 275 | +*[Quick View]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/#view-deployment-configuration-info-for-selected-argo-cd-application): View deployment, definition, and event information for the selected application in the same location. |
| 276 | +*[Synchronize]({{site.baseurl}}/docs/deployments/gitops/manage-application/#manually-synchronize-an-argo-cd-application): Manually synchronize the application to expedite Git-to-cluster sync. |
| 277 | +*[Edit]({{site.baseurl}}/docs/deployments/gitops/manage-application/#edit-argo-cd-application-definitions): Update General or Advanced configuration settings for the application. |
| 278 | +*[Refresh/Hard Refresh]({{site.baseurl}}/docs/deployments/gitops/manage-application/#refreshhard-refresh-argo-cd-applications): As an alternative to manually syncing an application, either sync the application with the desired state in Git (refresh), or sync the application with the desired state Git while removing the cache (hard refresh). |
| 279 | +*[Delete]({{site.baseurl}}/docs/deployments/gitops/manage-application/#delete-argo-cd-applications): Delete the application from Codefresh. |
| 280 | + |
| 281 | +{% include |
| 282 | +image.html |
| 283 | +lightbox="true" |
| 284 | +file="/images/gitops-products/app-context-menu-in-product.png" |
| 285 | +url="/images/gitops-products/app-context-menu-in-product.png" |
| 286 | +alt="Context menu with actions for Argo CD applications within Products" |
| 287 | +caption="Context menu with actions for Argo CD applications within Products" |
| 288 | + max-width="60%" |
| 289 | +%} |