Skip to content

Commit 0e3ba04

Browse files
authored
Updated app topics content (#783)
* Updated app topics content * Update applications-dashboard.md Fixed http syntax for xref * Update manage-application.md
1 parent 68be765 commit 0e3ba04

File tree

6 files changed

+143
-95
lines changed

6 files changed

+143
-95
lines changed

_docs/deployments/gitops/applications-dashboard.md

Lines changed: 78 additions & 86 deletions
Large diffs are not rendered by default.

_docs/deployments/gitops/create-application.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Application definitions include the name, runtime, and the name of the YAML mani
3838

3939
## Application: General configuration settings
4040

41-
General configuration settings define the source, destination, and sync policies for the application.
41+
General configuration settings define the group to which the application belongs, source, destination, and sync policies for the application.
4242

4343
{% include
4444
image.html
@@ -50,6 +50,14 @@ General configuration settings define the source, destination, and sync policies
5050
max-width="70%"
5151
%}
5252

53+
<!--- ### Groups
54+
Optional. The group or groups to which to add the application.
55+
You can group applications based on criteria meaningful to your organization, such as environment, region, or any other relevant attribute. You can then view deployments for these applications in the same location in the Groups tab of the GitOps Apps dashboard. A new view for GitOps Application, App Groups allow you to collate multiple applications view their timelines.
56+
57+
Select an existing group, or create a new application group by typing a name and pressing Enter.
58+
59+
-->
60+
5361
### Source
5462
The Git repository to be tracked for changes to the application's source code.
5563
{::nomarkdown}<ul> <li><b>Repository URL</b>: The Git repo or the Helm package repo with the application source code, to be tracked for changes. <br>If SSH is configured for the runtime, you can connect to the repo with either HTTPS or SSH. On selecting the repository, Codefresh automatically updates the URL format. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#configure-ssh-for-gitops-runtimes">Configure SSH for runtimes</a>.<br>If the Argo CD project is not the <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">default</span> project, make sure that the repo has the correct access roles for your application.<ul><li><b>Revision and Path</b>: Applies to Git repositories. </li><li><b>Chart</b>: Applies to Helm repositories. The name of the Helm package with all the resource definitions for the application, and the version. </li></ul>For more information, see <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/tracking_strategies/" target="\_blank">Tracking and Deployment Strategies</a>.</li></ul> {:/}

_docs/deployments/gitops/manage-application.md

Lines changed: 56 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,25 @@ Application creation and deployment is one part of the continuous deployment/del
1212
Optimize deployed applications by changing application definitions when needed.
1313

1414
* [Synchronize applications](#manually-synchronize-an-application)
15-
Sync applications on-demand by manually applying sync options or selecting the resources to sync.
15+
Sync applications on-demand by manually applying sync options or by manually selecting the resources to sync.
1616

17-
* [Rollback applications](#rollback-gitops-applications)
18-
Rollback an application to a previous deployment version.
17+
* [Terminate sync for applications](#terminate-on-going-sync-for-gitops-applications)
18+
With a single-click, terminate on-going sync processes when needed.
19+
20+
* [Refresh applications](#refreshhard-refresh-gitops-applications)
21+
Manually refresh applications with a single-click, as an alternative to manually synchronizing them.
1922

23+
* [Rollback applications](#rollback-gitops-applications)
24+
Rollback applications to previous deployment versions.
2025

21-
* [Manage rollouts for deployments](#manage-rollouts-for-deployments)
26+
* [Manage rollouts for deployments](#manage-rollouts-for-gitops-application-deployments)
2227
Control ongoing rollouts by resuming indefinitely paused steps, promoting rollouts, aborting, restarting and retrying rollouts.
2328

24-
* [Delete applications](#delete-an-application)
29+
* [Delete applications](#delete-gitops-applications)
2530
Delete unused or legacy applications to avoid clutter and remove unnecessary resources.
2631

32+
To delete specific resources within an application, see [Delete application resources]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/#delete-application-resources).
33+
2734

2835

2936

@@ -95,11 +102,13 @@ Update General or Advanced configuration settings for a deployed application thr
95102

96103

97104

105+
98106
## Manually synchronize an application
99107
Manually synchronize an application to expedite Git-to-cluster sync. The sync options selected for manual sync override the sync options defined for the application.
100108
The sync options, grouped into Revision and Additional Settings, are identical to the Sync options in the General settings when you created the application.
101109

102-
>You can also synchronize application resources with sync statuses, such as `Service`, `AnalysisTemplate`, and `Rollouts` resources for example, in the Current State tab. The context menu of the resource shows the Sync option.
110+
>**TIP**:
111+
You can also synchronize _application resources_ with sync statuses such as `Service`, `AnalysisTemplate`, and `Rollouts` resources for example, in the Current State tab. Select the Sync option from resource's context menu.
103112

104113
**Before you begin**
105114
* Review:
@@ -222,6 +231,45 @@ For example, if you made changes to `api` resources or `audit` resources, type `
222231
<br><br>
223232
{:/}
224233

234+
235+
## Terminate on-going sync for GitOps applications
236+
Manually terminate an on-going synchronization process for the application. You may need to terminate an on-going sync that remains indefinitely as Syncing, or because you have detected problems in the current deployment
237+
Terminating a sync operation reverts the deployment to the previously deployed version or image.
238+
239+
1. In the Codefresh UI, from Ops in the sidebar, select [GitOps Apps](https://g.codefresh.io/2.0/applications-dashboard/list){:target="\_blank"}.
240+
1. If needed, filter by **Status** **Syncing** to view applications with active sync operations.
241+
1. Select the application and then from the application header, click **Terminate Sync**.
242+
243+
{% include
244+
image.html
245+
lightbox="true"
246+
file="/images/applications/app-terminate-sync.png"
247+
url="/images/applications/app-terminate-sync.png"
248+
alt="Manually terminate on-going sync"
249+
caption="Manually terminate on-going sync"
250+
max-width="50%"
251+
%}
252+
253+
254+
## Refresh/hard refresh GitOps applications
255+
256+
As an alternative to manually syncing an application, either refresh or hard refresh the application. Both options are always available in the application toolbar.
257+
258+
1. In the Codefresh UI, from Ops in the sidebar, select [GitOps Apps](https://g.codefresh.io/2.0/applications-dashboard/list){:target="\_blank"}.
259+
1. Select the application, and then from the top-right, select the required action:
260+
* **Refresh**: Retrieve desired (Git) state, compare with the live (cluster) state, and refresh the application to sync with the desired state.
261+
* **Hard Refresh**: Refresh the application to sync with the Git state, while removing the cache.
262+
263+
{% include
264+
image.html
265+
lightbox="true"
266+
file="/images/applications/app-refresh-hard-refresh.png"
267+
url="/images/applications/app-refresh-hard-refresh.png"
268+
alt="Refresh/Hard Refresh for applications"
269+
caption="Refresh/Hard Refresh for applications"
270+
max-width="50%"
271+
%}
272+
225273
## Rollback GitOps applications
226274
Rollback to a previously deployed version of active GitOps applications. You may want to rollback a newly deployed version due to errors in your code or misconfigurations, etc.
227275

@@ -316,7 +364,7 @@ caption="Rollback completed for application"
316364
max-width="70%"
317365
%}
318366

319-
## Manage rollouts for deployments
367+
## Manage rollouts for GitOps application deployments
320368
Control ongoing rollouts by resuming indefinitely paused steps, promoting rollouts, aborting, restarting and retrying rollouts.
321369

322370
{::nomarkdown}
@@ -426,7 +474,7 @@ The table describes the options for the `Rollout` resource.
426474
|**Retry** | Retry a rollout that has been aborted. Available only when a rollout has been aborted. |
427475
|**Skip-current-step** | Skip executing the current step, and continue with the next step. |
428476

429-
## Delete an application
477+
## Delete GitOps applications
430478
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 GitOps Apps dashboard in Codefresh.
431479

432480
>**Prune resources** in the application's General settings determines the scope of the delete action.
103 KB
Loading
59.2 KB
Loading
158 KB
Loading

0 commit comments

Comments
 (0)