Skip to content

Commit cdc2235

Browse files
authored
Cf applications refactor (#248)
* Update app topics * Update app dashboard topic * Updates * Update app dashboard rewrite app dashboard from functionality point of view * Update apps dashboard Refactor content to reflect functionality * Update applications dashboard More content updates and new screenshots * Updates to x-refs Updated x-refs to apps dashboard after renaming app topics as creation, monitoring, and managing * Update applications-dashboard.md * Update x-refs * Update applications-dashboard.md Typos * Update manage-application.md Minor fixes * Updates to management and nav titles * Update manage-application.md * Updates to UI links App dashboard UI link changes * Update manage-application.md * Update manage-application.md * Updates
1 parent 3bcffc7 commit cdc2235

36 files changed

+752
-472
lines changed

_data/home-content.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,12 @@
6464
icon: images/home-icons/deployment.svg
6565
url: ''
6666
links:
67-
- title: Applications dashboard
68-
localurl: /docs/deployment/applications-dashboard/
69-
- title: Applications
67+
- title: Creating applications
7068
localurl: /docs/deployment/create-application/
69+
- title: Monitoring applications
70+
localurl: /docs/deployment/applications-dashboard/
71+
- title: Managing applications
72+
localurl: /docs/deployment/manage-application/
7173
- title: Images in Codefresh
7274
localurl: /docs/deployment/images/
7375
- title: Install Argo Rollouts

_data/nav.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,12 @@
8181
- title: Deployment
8282
url: "/deployment"
8383
pages:
84-
- title: Applications dashboard
85-
url: "/applications-dashboard"
86-
- title: Applications
84+
- title: Creating applications
8785
url: "/create-application"
86+
- title: Monitoring applications
87+
url: "/applications-dashboard"
88+
- title: Managing applications
89+
url: "/manage-application"
8890
- title: Images in Codefresh
8991
url: "/images"
9092
- title: Install Argo Rollouts

_docs/deployment/applications-dashboard.md

Lines changed: 363 additions & 283 deletions
Large diffs are not rendered by default.

_docs/deployment/create-application.md

Lines changed: 11 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Applications"
2+
title: "Creating applications"
33
description: ""
44
group: deployment
55
toc: true
@@ -14,12 +14,12 @@ Codefresh provides all the options and functionality to create and manage Argo C
1414
* General configuration settings
1515
* Advanced configuration settings
1616

17-
The Create application wizard guides you through the process of creating an application. For how-to information, see [Create an Argo CD application](#how-to-create-an-argo-cd-application).
17+
The Create application wizard guides you through the process of creating an application. For how-to information, see [Create an application](#create-an-application).
1818
For example Argo CD applications, see this [repo](https://github.com/oleksandr-codefresh/argocd-example-apps){:target="_blank"}.
1919

2020
* Edit and delete applications
2121
Once the application is created and synced to the cluster, it is displayed in the Applications dashboard. Here, you can select an application to update the application's configuration settings, or delete it.
22-
To monitor the health and sync status, deployments, and resources for the application, see [Applications dashboard]({{site.baseurl}}/docs/deployment/applications-dashboard/).
22+
To monitor the health and sync status, deployments, and resources for the application, see [Monitoring applications]({{site.baseurl}}/docs/deployment/applications-dashboard/).
2323

2424
### Application: Definitions
2525
Application definitions include the name, runtime, and the name of the YAML manifest. By default, the YAML manifest has the same name as that of the application.
@@ -74,10 +74,10 @@ The cluster and namespace to which to deploy the application.
7474
{:/}
7575

7676
##### Sync Options
77-
{::nomarkdown}Common to both manual and automatic sync policies.</br><ul><li><b>Skip schema validation</b>: When selected, bypasses validating the YAML schema.</li><li><b>Auto-create namespace</b>: When selected, automatically create the namespace if the specified namespace does not exist in the cluster.</li><li><b>Prune last</b>: When selected, removes those resources that do not exist in the currently deployed version during the final wave of the sync operation. See <a hef="https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/#prune-last" target="_blank">Prune last</a>.</li><li><b>Apply out of sync only</b>: When selected, syncs only those resources in the application that have been changed and are <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">OutOfSync</span>, instead of syncing every resource regardless of their state. This option is useful to reduce load and save time when you have thousands of resources in an application. See <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/#selective-sync" target="_blank">Selective Sync</a>.</li></ul> {:/}
77+
{::nomarkdown}Common to both manual and automatic sync policies.</br><ul><li><b>Skip schema validation</b>: When selected, bypasses validating the YAML schema.</li><li><b>Auto-create namespace</b>: When selected, automatically create the namespace if the specified namespace does not exist in the cluster.</li><li><b>Prune last</b>: When selected, removes those resources that do not exist in the currently deployed version during the final wave of the sync operation. See <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/#prune-last" target="_blank">Prune last</a>.</li><li><b>Apply out of sync only</b>: When selected, syncs only those resources in the application that have been changed and are <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">OutOfSync</span>, instead of syncing every resource regardless of their state. This option is useful to reduce load and save time when you have thousands of resources in an application. See <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/#selective-sync" target="_blank">Selective Sync</a>.</li></ul> {:/}
7878

7979
{::nomarkdown}
80-
<br>
80+
<br><br>
8181
{:/}
8282

8383
##### Prune propagation policy
@@ -150,7 +150,7 @@ Review:
150150

151151

152152
**How to**
153-
1. In the Codefresh UI, go to [Applications](https://g.codefresh.io/2.0/applications-dashboard?sort=desc-lastUpdated){:target="\_blank"}.
153+
1. In the Codefresh UI, go to [Applications dashboard](https://g.codefresh.io/2.0/applications-dashboard/list){:target="\_blank"}.
154154
1. On the top-right, select **Add Application**.
155155
1. In the Add Application panel, add definitions for the application:
156156
* Application name: Must be unique within the cluster.
@@ -217,111 +217,15 @@ Review:
217217

218218

219219
Your application is first committed to Git, and then synced to the cluster which may take a few moments.
220-
Track the application in the [Applications dashboard](https://g.codefresh.io/2.0/applications-dashboard){:target="_blank"}.
220+
Track the application in the [Applications dashboard](https://g.codefresh.io/2.0/applications-dashboard/list){:target="_blank"}.
221221

222222
{::nomarkdown}
223223
<br><br>
224224
{:/}
225225

226-
### Update application configuration
227-
Update General or Advanced configuration settings for a deployed application. Once the application is deployed to the cluster, the Configuration tab is available on selecting the application in the Applications dashboard.
228-
229-
> You cannot change application definitions (the application name and the selected runtime), and the Git Source selected for the application.
230-
231-
**How to**
232-
233-
1. In the Codefresh UI, go to the [Applications dashboard](https://g.codefresh.io/2.0/applications-dashboard){:target="\_blank"}.
234-
1. Select the application to update, and then select the **Configuration** tab.
235-
236-
{% include
237-
image.html
238-
lightbox="true"
239-
file="/images/applications/edit-app-configuration-tab.png"
240-
url="/images/applications/edit-app-configuration-tab.png"
241-
alt="Configuration tab with application settings"
242-
caption="Configuration tab with application settings"
243-
max-width="70%"
244-
%}
245-
246-
{:start="3"}
247-
1. Update the **General** or **Advanced** configuration settings as needed:
248-
[General configuration](#general-configuration-settings)
249-
[Advanced configuration](#advanced-configuration-settings)
250-
When you change a setting, the Commit and Discard Changes buttons are displayed.
251-
252-
{% include
253-
image.html
254-
lightbox="true"
255-
file="/images/applications/edit-app-change-setting.png"
256-
url="/images/applications/edit-app-change-setting.png"
257-
alt="Edit application settings"
258-
caption="Edit application settings"
259-
max-width="70%"
260-
%}
261-
262-
{:start="4"}
263-
1. Do one of the following:
264-
* To _commit all changes_, click **Commit**. This final commit screen is displayed with a diff view of the changes.
265-
* To _undo all changes_ and return to the previous settings, click **Discard Changes**. This action removes all the changes you have made so far and returns you to the Applications dashboard.
266-
267-
>If you change settings and then restore existing values for the same, Codefresh automatically removes the Commit and Discard Changes buttons as there are no new changes to commit or discard.
268-
269-
{% include
270-
image.html
271-
lightbox="true"
272-
file="/images/applications/edit-app-diff-view.png"
273-
url="/images/applications/edit-app-diff-view.png"
274-
alt="Commit changes with diff view"
275-
caption="Commit changes with diff view"
276-
max-width="70%"
277-
%}
278-
279-
{:start="5"}
280-
1. To confirm all changes, at the bottom-left, click **Commit**.
281-
The changes are committed to Git, and in a few moments also synced to the cluster.
282-
283-
{::nomarkdown}
284-
<br><br>
285-
{:/}
286-
287-
### Delete an application
288-
Delete an application from Codefresh. Deleting an application deletes the manifest from the Git repository, and then from the cluster where it is deployed. When deleted from the cluster, the application is removed from the Applications dashboard in Codefresh.
289-
290-
>The Prune resources setting determines the scope of the delete action. When selected, both the application and its resources are deleted. When not selected, only the application is deleted. For more information, review [Sync settings](#sync-settings) in this article.
291-
Codefresh warns you of the implication of deleting the selected application in the Delete form.
292-
293-
1. In the Codefresh UI, go to the [Applications dashboard](https://g.codefresh.io/2.0/applications-dashboard){:target="\_blank"}.
294-
1. Select the application to delete.
295-
1. Click the three dots for additional actions, and select **Delete**.
296-
297-
{% include
298-
image.html
299-
lightbox="true"
300-
file="/images/applications/app-delete-option.png"
301-
url="/images/applications/app-delete-option.png"
302-
alt="Delete application"
303-
caption="Delete application"
304-
max-width="80%"
305-
%}
306-
307-
Pay attention to the impact of the delete action for the selected application that Codefresh displays.
308-
309-
{% include
310-
image.html
311-
lightbox="true"
312-
file="/images/applications/delete-app-prune-affects.png"
313-
url="/images/applications/delete-app-prune-affects.png"
314-
alt="Prune setting impact on deleting application"
315-
caption="Prune setting impact on deleting application"
316-
max-width="70%"
317-
%}
318-
319-
{:start="4"}
320-
1. To confirm, click **Commit & Delete**.
321-
322-
{::nomarkdown}
323-
<br><br>
324-
{:/}
325226

326-
### What to read next
227+
### Related articles
228+
[Monitoring applications]({{site.baseurl}})/docs/deployment/applications-dashboard)
229+
[Managing applications]({{site.baseurl}})/docs/deployment/manage-applications)
230+
[Home dashboard]({{site.baseurl}})docs/reporting/home-dashboard)
327231
[DORA metrics]({{site.baseurl}}/docs/reporting/dora-metrics/)

0 commit comments

Comments
 (0)