You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/deployments/gitops.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,10 +7,10 @@ toc: true
7
7
8
8
Codefresh has a native module for GitOps deployments powered by Argo CD and Argo Rollouts. It also has native support for Argo Events and Argo Workflows.
9
9
10
-
* Create a[GitOps Application]({{site.baseurl}}/docs/deployments/helm/managed-helm-repository/) either from the GUI or the CLI.
11
-
*[Monitor your GitOps applications]({{site.baseurl}}/docs/deployments/helm/helm-charts-and-repositories/) and check their health status
12
-
* You can[edit/delete/rollback]({{site.baseurl}}/docs/deployments/helm/helm-releases-management/) applications while still keeping the state in Git.
13
-
* Perform[Canary releases]({{site.baseurl}}/docs/deployments/helm/helm-environment-promotion/) via the dedicated UI
10
+
* Create a[GitOps Application]({{site.baseurl}}/docs/deployments/gitops/create-application/) either from the GUI or the CLI.
11
+
*[Monitor your GitOps applications]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/) and check their health status
12
+
* You can[edit/delete/rollback]({{site.baseurl}}/docs/deployments/gitops/manage-application/) applications while still keeping the state in Git.
13
+
* Perform[Canary releases]({{site.baseurl}}/docs/deployments/gitops/install-argo-rollouts/) via the dedicated UI
Copy file name to clipboardExpand all lines: _docs/deployments/gitops/applications-dashboard.md
+38-26Lines changed: 38 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -265,18 +265,29 @@ max-width="50%"
265
265
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.
266
266
267
267
**Context menu**
268
-
Every resource has a context menu that opens on clicking the three dots on the right of the node. The options available differ according to the type of resource.
268
+
Every resource has a context menu that opens on clicking the three dots on the right of the resource. The options available differ according to the type of resource.
269
+
>If you have deep links configured for applications/resources for Hybrid GitOps Runtimes, these are also displayed in the context menu. To configure deep links in Codefresh, see[(Hybrid GitOps) Configure Deep Links to applications & resources]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#hybrid-gitops-configure-deep-links-to-applications--resources).
alt="Current State Tree view: Resource inventory filtered byRollouts"
324
-
caption="Current State Tree view: Resource inventory filtered byRollouts"
334
+
alt="Current State Tree view: Resource inventory filtered bySecrets"
335
+
caption="Current State Tree view: Resource inventory filtered bySecrets"
325
336
max-width="50%"
326
337
%}
327
338
@@ -363,18 +374,19 @@ max-width="50%"
363
374
364
375
###Health status for application resources
365
376
View and monitor health status of the selected application's resources in the Current State tab, in Tree or List views.
366
-
Identify the health of an application resource through thecolor-coded border andtheresource-type icon (Tree view), or the textual labels at the right of the resource (List view).
377
+
Identify the health of an application resource through theicon, as described inthetable (Tree view), or the textual labels at the right of the resource (List view).
367
378
379
+
The table describes the possible health statuses for an application resource in the Tree view.
368
380
369
381
{: .table .table-bordered .table-hover}
370
-
| Healthstatus| Description| Display in Tree view|
|**Healthy**| Resource is functioning as required.|{::nomarkdown}<img src="../../../../images/icons/current-state-healthy.png" display=inline-block">{:/}|
373
-
|**Progressing**| Resource is not healthy but can become healthy before the timeout occurs.|{::nomarkdown}<img src="../../../../images/icons/current-state-progressing.png" display=inline-block">{:/}|
374
-
|**Suspended**| Resource is not functioning, and is either suspended or paused. For example, Cron job or a canary rollout.|{::nomarkdown}<img src="../../../../images/icons/current-state-suspended.png" display=inline-block">{:/}|
375
-
|**Missing**| Resource is not present on the cluster.|{::nomarkdown}<img src="../../../../images/icons/current-state-missing.png" display=inline-block">{:/}|
376
-
|**Degraded**| Resource is not healthy, or a timeout occurred before it could reach a healthy status.|{::nomarkdown}<imgsrc="../../../../images/icons/current-state-degraded.png"display=inline-block/>{:/}|
377
-
|**Unknown**| Resource does not have a health status, or the health status is not tracked in Argo CD. For example,`ConfigMaps` resource types.| {::nomarkdown}<img src="../../../../images/icons/current-state-unknown.png" display=inline-block">{:/}|
384
+
| {::nomarkdown}<img src="../../../../images/icons/current-state-healthy.png" display=inline-block">{:/}|**Healthy**| Resource is functioning as required.|
385
+
| {::nomarkdown}<img src="../../../../images/icons/current-state-progressing.png" display=inline-block">{:/}|**Progressing**| Resource is not healthy but can become healthy before the timeout occurs.|
386
+
| {::nomarkdown}<img src="../../../../images/icons/current-state-suspended.png" display=inline-block">{:/}|**Suspended**| Resource is not functioning, and is either suspended or paused. For example, Cron job or a canary rollout.|
387
+
|{::nomarkdown}<img src="../../../../images/icons/current-state-missing.png" display=inline-block">{:/}|**Missing**| Resource is not present on the cluster.|
388
+
| {::nomarkdown}<imgsrc="../../../../images/icons/current-state-degraded.png"display=inline-block/>{:/}|**Degraded**| Resource is not healthy, or a timeout occurred before it could reach a healthy status.|
389
+
|{::nomarkdown}<imgsrc="../../../../images/icons/current-state-unknown.png"display=inline-block/>{:/}|**Unknown**| Resource does not have a health status, or the health status is not tracked in Argo CD. For example,`ConfigMaps` resource types.|
378
390
379
391
380
392
See also[Argo CD's set of health checks](https://argo-cd.readthedocs.io/en/stable/operator-manual/health/){:target="\_blank"}.
@@ -384,17 +396,17 @@ See also [Argo CD's set of health checks](https://argo-cd.readthedocs.io/en/stab
384
396
###Sync status for application resources
385
397
386
398
Similar to the health status, the Current State also tracks the sync status of all application resources. The sync status identifies if the live state of the application resource on the cluster is synced with its desired state in Git.
387
-
Identify the sync status through the icon on the left of the resource nameand the color of the resource name(Tree view), or the textual labels at the right of the resource (List view).
399
+
Identify the sync status through the icon on the left of the resource name (Tree view), or the textual labels at the right of the resource (List view).
388
400
389
-
The table describes the possible syncstatuses for an application resource, and its representation in the Tree view.
401
+
The table describes the possible syncstates for an application resource in the Tree view.
390
402
391
403
{: .table .table-bordered .table-hover}
392
-
| Syncstate| Description|Display in Tree view|
404
+
| Syncicon| Sync state|Description|
393
405
| --------------| ----------| ----------|
394
-
|**Synced**| The live state of the resource on the cluster is identical to the desired state in Git.|{::nomarkdown}<img src="../../../../images/icons/current-state-synced.png" display=inline-block">{:/}|
395
-
|**Syncing**| The live state of the resource was not identical to the desired state, and is currently being synced.|{::nomarkdown}<imgsrc="../../../../images/icons/current-state-syncing.png"display=inline-block/>{:/}|
396
-
|**Out-of-Sync**|{::nomarkdown}The live state is not identical to the desired state.<br>To sync a resource, select the<b>Sync</b> option from the resource's context menu in Tree view.{:/}| {::nomarkdown}<img src="../../../../images/icons/current-state-out-of-sync.png" display=inline-block">{:/}|
397
-
|**Unknown**| The sync status could not be determined.| {::nomarkdown}<img src="../../../../images/icons/current-state-sync-unknown.png" display=inline-block">{:/}|
406
+
| {::nomarkdown}<img src="../../../../images/icons/current-state-synced.png" display=inline-block">{:/}|**Synced**| The live state of the resource on the cluster is identical to the desired state in Git.|
407
+
| {::nomarkdown}<imgsrc="../../../../images/icons/current-state-syncing.png"display=inline-block/>{:/}|**Syncing**| The live state of the resource was not identical to the desired state, and is currently being synced.|
408
+
|{::nomarkdown}<img src="../../../../images/icons/current-state-out-of-sync.png" display=inline-block">{:/}|**Out-of-Sync**| The live state is not identical to the desired state.<br>To sync a resource, select the**Sync** option from the resource's context menu in Tree view.|
409
+
|No icon|**Unknown**| The sync status could not be determined.|
398
410
399
411
400
412
>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 table lists the controls in the Rollout Player to manage an ongoing rollout.
630
642
631
643
{: .table .table-bordered .table-hover}
632
-
|Rollback playeroption| Description|
644
+
|Rollback playericon| Option| Description|
633
645
| --------------| ------------|
634
-
|**Rollback**| Not available currently.|
635
-
|**Resume**{::nomarkdown}<img src="../../../../images/icons/rollout-resume.png" display=inline-block"> {:/}| Resume a step that has been paused indefinitely.|
636
-
|**Skip step**{::nomarkdown}<img src="../../../../images/icons/rollout-skip-step.png" display=inline-block"> {:/}| Skip execution of current step. Such steps are marked as Skipped in the rollout visualization.|
637
-
|**Promote full rollout**{::nomarkdown}<img src="../../../../images/icons/rollout-promote-full.png" display=inline-block"> {:/}| Skip remaining pause, traffic routing, and analysis steps, and deploy the current release.|
646
+
|{::nomarkdown}<img src="../../../../images/icons/rollout-rollback.png" display=inline-block"> {:/}|**Rollback**| Rollback rollout to the selec.|
647
+
| {::nomarkdown}<img src="../../../../images/icons/rollout-resume.png" display=inline-block"> {:/}|**Resume**| Resume a step that has been paused indefinitely.|
648
+
| {::nomarkdown}<img src="../../../../images/icons/rollout-skip-step.png" display=inline-block"> {:/}|**Skip step**| Skip execution of current step. Such steps are marked as Skipped in the rollout visualization.|
649
+
| {::nomarkdown}<img src="../../../../images/icons/rollout-promote-full.png" display=inline-block"> {:/}|**Promote full rollout**| Skip remaining pause, traffic routing, and analysis steps, and deploy the current release.|
Copy file name to clipboardExpand all lines: _docs/deployments/gitops/create-application.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ General configuration settings define the source, destination, and sync policies
52
52
53
53
###Source
54
54
The Git repository to be tracked for changes to the application's source code.
55
-
{::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. If the Argo CD project is not the <spanstyle="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 <ahref="https://argo-cd.readthedocs.io/en/stable/user-guide/tracking_strategies/"target="\_blank">Tracking and Deployment Strategies</a>.</li></ul> {:/}
55
+
{::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> {:/}
56
56
57
57
{::nomarkdown}
58
58
<br>
@@ -116,7 +116,7 @@ Advanced settings define the tool used to create the application, and related to
116
116
{:/}
117
117
118
118
###ArgoCD Project
119
-
The project group to which the application belongs. A project is useful to enforce restrictions on permitted sources and targets for applications, and roles. If not defined, the application is automatically assigned to the`default` project, which is created automatically by Argo CD and has no restrictions.
119
+
The project group to which the application belongs. A project is useful to enforce restrictions on permitted sources and targets for applications and roles. If not defined, the application is automatically assigned to the`default` project, which is created automatically by Argo CD and has no restrictions.
120
120
For more information, see Argo CD's documentation on[Projects](https://argo-cd.readthedocs.io/en/stable/user-guide/projects/#projects){:target="\_blank"}.
Copy file name to clipboardExpand all lines: _docs/deployments/gitops/manage-application.md
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,6 +89,9 @@ Update General or Advanced configuration settings for a deployed application thr
89
89
<br><br>
90
90
{:/}
91
91
92
+
93
+
94
+
92
95
##Manually synchronize an application
93
96
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.
94
97
The sync options, grouped into Revision and Additional Settings, are identical to the Sync options in the General settings when you created the application.
@@ -120,9 +123,10 @@ The sync options, grouped into Revision and Additional Settings, are identical t
120
123
***All**: Sync all resources regardless of their sync state.
121
124
***Out of sync**: Sync_only_ resources that are`Out of sync`.
122
125
123
-
{::nomarkdown}
124
-
<br>
125
-
{:/}
126
+
127
+
<br><br>
128
+
129
+
126
130
127
131
###Revision settings for application sync
128
132
Revision settings determine the behavior for the branch you select.
>Note that this page explains how to run Terraform inside a Codefresh pipeline. If you want to use Terraform to manage Codefresh itself see the[Terraform provider](https://registry.terraform.io/providers/codefresh-io/codefresh/latest).
27
+
25
28
##The example Terraform project
26
29
27
30
You can see the example project at[https://github.com/codefresh-contrib/terraform-sample-app](https://github.com/codefresh-contrib/terraform-sample-app){:target="\_blank"}. The repository contains a simple Terraform definition that creates a VM on Google cloud.