diff --git a/public/docs/i/1000/argo-cd/argo-cd-diff.webp b/public/docs/i/1000/argo-cd/argo-cd-diff.webp new file mode 100644 index 0000000000..10c8c17070 Binary files /dev/null and b/public/docs/i/1000/argo-cd/argo-cd-diff.webp differ diff --git a/public/docs/i/1000/argo-cd/argo-cd-live-status-dashboard.webp b/public/docs/i/1000/argo-cd/argo-cd-live-status-dashboard.webp new file mode 100644 index 0000000000..35379c320d Binary files /dev/null and b/public/docs/i/1000/argo-cd/argo-cd-live-status-dashboard.webp differ diff --git a/public/docs/i/1000/argo-cd/argo-cd-live-status-objects.webp b/public/docs/i/1000/argo-cd/argo-cd-live-status-objects.webp new file mode 100644 index 0000000000..df9ff5105f Binary files /dev/null and b/public/docs/i/1000/argo-cd/argo-cd-live-status-objects.webp differ diff --git a/public/docs/i/1000/argo-cd/octopus-argo-cd-diff.webp b/public/docs/i/1000/argo-cd/octopus-argo-cd-diff.webp new file mode 100644 index 0000000000..3a386a7ccb Binary files /dev/null and b/public/docs/i/1000/argo-cd/octopus-argo-cd-diff.webp differ diff --git a/public/docs/i/2000/argo-cd/argo-cd-diff.webp b/public/docs/i/2000/argo-cd/argo-cd-diff.webp new file mode 100644 index 0000000000..f7f3ac6d4f Binary files /dev/null and b/public/docs/i/2000/argo-cd/argo-cd-diff.webp differ diff --git a/public/docs/i/2000/argo-cd/argo-cd-live-status-dashboard.webp b/public/docs/i/2000/argo-cd/argo-cd-live-status-dashboard.webp new file mode 100644 index 0000000000..f983f9bcff Binary files /dev/null and b/public/docs/i/2000/argo-cd/argo-cd-live-status-dashboard.webp differ diff --git a/public/docs/i/2000/argo-cd/argo-cd-live-status-objects.webp b/public/docs/i/2000/argo-cd/argo-cd-live-status-objects.webp new file mode 100644 index 0000000000..5672465bca Binary files /dev/null and b/public/docs/i/2000/argo-cd/argo-cd-live-status-objects.webp differ diff --git a/public/docs/i/2000/argo-cd/octopus-argo-cd-diff.webp b/public/docs/i/2000/argo-cd/octopus-argo-cd-diff.webp new file mode 100644 index 0000000000..ae0457d8d0 Binary files /dev/null and b/public/docs/i/2000/argo-cd/octopus-argo-cd-diff.webp differ diff --git a/public/docs/i/600/argo-cd/argo-cd-diff.webp b/public/docs/i/600/argo-cd/argo-cd-diff.webp new file mode 100644 index 0000000000..2da1c439f2 Binary files /dev/null and b/public/docs/i/600/argo-cd/argo-cd-diff.webp differ diff --git a/public/docs/i/600/argo-cd/argo-cd-live-status-dashboard.webp b/public/docs/i/600/argo-cd/argo-cd-live-status-dashboard.webp new file mode 100644 index 0000000000..7b9d3fd14c Binary files /dev/null and b/public/docs/i/600/argo-cd/argo-cd-live-status-dashboard.webp differ diff --git a/public/docs/i/600/argo-cd/argo-cd-live-status-objects.webp b/public/docs/i/600/argo-cd/argo-cd-live-status-objects.webp new file mode 100644 index 0000000000..2a30e21ec1 Binary files /dev/null and b/public/docs/i/600/argo-cd/argo-cd-live-status-objects.webp differ diff --git a/public/docs/i/600/argo-cd/octopus-argo-cd-diff.webp b/public/docs/i/600/argo-cd/octopus-argo-cd-diff.webp new file mode 100644 index 0000000000..2722ce262f Binary files /dev/null and b/public/docs/i/600/argo-cd/octopus-argo-cd-diff.webp differ diff --git a/public/docs/i/x/argo-cd/argo-cd-diff.png b/public/docs/i/x/argo-cd/argo-cd-diff.png new file mode 100644 index 0000000000..945e679e2e Binary files /dev/null and b/public/docs/i/x/argo-cd/argo-cd-diff.png differ diff --git a/public/docs/i/x/argo-cd/argo-cd-live-status-dashboard.png b/public/docs/i/x/argo-cd/argo-cd-live-status-dashboard.png new file mode 100644 index 0000000000..539128c9cf Binary files /dev/null and b/public/docs/i/x/argo-cd/argo-cd-live-status-dashboard.png differ diff --git a/public/docs/i/x/argo-cd/argo-cd-live-status-objects.png b/public/docs/i/x/argo-cd/argo-cd-live-status-objects.png new file mode 100644 index 0000000000..535b53958c Binary files /dev/null and b/public/docs/i/x/argo-cd/argo-cd-live-status-objects.png differ diff --git a/public/docs/i/x/argo-cd/octopus-argo-cd-diff.png b/public/docs/i/x/argo-cd/octopus-argo-cd-diff.png new file mode 100644 index 0000000000..50c2089886 Binary files /dev/null and b/public/docs/i/x/argo-cd/octopus-argo-cd-diff.png differ diff --git a/public/docs/img/argo-cd/argo-cd-diff.png b/public/docs/img/argo-cd/argo-cd-diff.png new file mode 100644 index 0000000000..8e9d0ca7a6 Binary files /dev/null and b/public/docs/img/argo-cd/argo-cd-diff.png differ diff --git a/public/docs/img/argo-cd/argo-cd-diff.png.json b/public/docs/img/argo-cd/argo-cd-diff.png.json new file mode 100644 index 0000000000..a92faf0abd --- /dev/null +++ b/public/docs/img/argo-cd/argo-cd-diff.png.json @@ -0,0 +1 @@ +{"width":2394,"height":862,"updated":"2025-11-26T06:39:17.671Z"} \ No newline at end of file diff --git a/public/docs/img/argo-cd/argo-cd-live-status-dashboard.png b/public/docs/img/argo-cd/argo-cd-live-status-dashboard.png new file mode 100644 index 0000000000..8e45146d4c Binary files /dev/null and b/public/docs/img/argo-cd/argo-cd-live-status-dashboard.png differ diff --git a/public/docs/img/argo-cd/argo-cd-live-status-dashboard.png.json b/public/docs/img/argo-cd/argo-cd-live-status-dashboard.png.json new file mode 100644 index 0000000000..2f65b0b127 --- /dev/null +++ b/public/docs/img/argo-cd/argo-cd-live-status-dashboard.png.json @@ -0,0 +1 @@ +{"width":2808,"height":1554,"updated":"2025-11-26T02:26:47.545Z"} \ No newline at end of file diff --git a/public/docs/img/argo-cd/argo-cd-live-status-objects.png b/public/docs/img/argo-cd/argo-cd-live-status-objects.png new file mode 100644 index 0000000000..2f624b0488 Binary files /dev/null and b/public/docs/img/argo-cd/argo-cd-live-status-objects.png differ diff --git a/public/docs/img/argo-cd/argo-cd-live-status-objects.png.json b/public/docs/img/argo-cd/argo-cd-live-status-objects.png.json new file mode 100644 index 0000000000..5614065db4 --- /dev/null +++ b/public/docs/img/argo-cd/argo-cd-live-status-objects.png.json @@ -0,0 +1 @@ +{"width":3790,"height":1716,"updated":"2025-11-26T02:26:47.674Z"} \ No newline at end of file diff --git a/public/docs/img/argo-cd/octopus-argo-cd-diff.png b/public/docs/img/argo-cd/octopus-argo-cd-diff.png new file mode 100644 index 0000000000..8231eea098 Binary files /dev/null and b/public/docs/img/argo-cd/octopus-argo-cd-diff.png differ diff --git a/public/docs/img/argo-cd/octopus-argo-cd-diff.png.json b/public/docs/img/argo-cd/octopus-argo-cd-diff.png.json new file mode 100644 index 0000000000..34bbd69cb1 --- /dev/null +++ b/public/docs/img/argo-cd/octopus-argo-cd-diff.png.json @@ -0,0 +1 @@ +{"width":1921,"height":536,"updated":"2025-11-26T06:39:17.725Z"} \ No newline at end of file diff --git a/src/pages/docs/argo-cd/live-object-status/index.md b/src/pages/docs/argo-cd/live-object-status/index.md new file mode 100644 index 0000000000..674c2c1c07 --- /dev/null +++ b/src/pages/docs/argo-cd/live-object-status/index.md @@ -0,0 +1,104 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2025-03-28 +modDate: 2025-05-16 +navSection: Live Object Status +title: Argo CD Live Object Status +navTitle: Live Object Status +description: Argo CD Live Object Status guide. +navOrder: 45 +hideInThisSectionHeader: true +--- +Argo Live Object Status shows the live status of the Kubernetes resources deployed by the Argo CD Applications mapped +to the project. +This allows you to monitor and safely troubleshoot Argo CD controlled deployments from within Octopus Deploy + +:::div{.info} +Outwardly this is an identical capability to that available for [Kubernetes based projects](/docs/kubernetes/live-object-status). +However when used with Argo CD, neither the [Kubernetes agent](/docs/kubernetes/targets/kubernetes-agent) nor the [Kubernetes monitor](/docs/kubernetes/targets/kubernetes-agent/kubernetes-monitor) are required. +::: + +## Where it is available +Using Argo CD Live Objet Status requires the following: +* Octopus Deploy 2025.4+ +* A registered [Argo CD Instance](/docs/argo-cd/instances/) +* [Annotations](/docs/argo-cd/annotations) on your Argo CD Applications, mapping them onto Octopus Deploy projects +* A deployment process containing an Argo CD step (either [Update Argo CD Image Tags](/docs/argo-cd/steps/update-application-image-tags) or [Update Argo CD Application Manifests](/docs/argo-cd/steps/update-application-manifests)) + +## How to use Live Status +Once the prerequisites have been fulfilled, simply toggle the switch on the dashboard to show live status in place of deployment status. + +:::figure +![Octopus Argo CD Live Status Dashboard](/docs/img/argo-cd/argo-cd-live-status-dashboard.png) +::: + +Octopus populates the Live Status Table with content taken directly from Argo. + +:::figure +![Octopus Argo CD Live Status Objects](/docs/img/argo-cd/argo-cd-live-status-objects.png) +::: + +### Project Live Status + +The project status is a roll-up of the status of all objects, in line with the following table: + +| Label | Status Icon | Description | +| :---------- | :------------------------------------------------: |:--------------------------------------------------------------------------------------------------------------------------| +| Progressing | | One or more objects of the mapped application are in a progressing state | +| Healthy | | The objects in the cluster match that specified in the applications' source git repositories, and are executing correctly | +| Unknown | | We’re having trouble getting live status updates for this application | +| Degraded | | Your objects experienced errors after the deployment completed | +| Out of Sync | | Argo CD has detected differences between the application's git repository, and the manifest in the cluster. | +| Missing | | One or more desired objects are missing from the cluster | +| Unavailable | | Application live status is unavailable because your last deployment failed | +| Waiting | | Application live status will be available once the deployment completes | + +### Object status + +| Label | Status Icon | Description | +| :---------- | :-------------------------------------------: |:------------------------------------------------------------------------------------------------------------| +| Progressing | | Object is attempting to reach the desired state | +| Healthy | | Object is in sync and reporting that it is running as expected | +| Unknown | | We don't have information about the live status of this object | +| Degraded | | Object has run into a problem, check the logs or events to find out more | +| Out of Sync | | Object manifest in the cluster is different from that specified in the Argo CD application's git repository | +| Missing | | Object is missing from the cluster | +| In Sync | | Object manifest matches what was applied, but does not report any additional health status | +| Suspended | | Job is not currently running | + + +### Detailed object information +Selecting an object or application name in the table will open a drawer containing detailed information. + +The drawer contains up-to-date information regarding the selected object: +* Summary +* Events +* Logs +* Kubernetes yaml manifest + +For Argo CD, all of these data fields are fetched on demand from your Argo instance. We do not currently support tailing logs. + +#### Manifest Diffs +Octopus presents manifest diffs in the _opposite order_ to that shown in Argo. + +In Argo, the left panel shows the live manifest in the cluster, and the right-panel shows the manifest that will be deployed when the application/resource is synced. + +In Octopus, the left panel indicates "what was most recently written to the git repository", while the right shows the live manifest. + + +| | Left | Right | +|---------|--------------------------------------------------------------|-------------------------------------------------------------------| +| Octopus | Manifest written to git repository as part of last release | The live manifest in the cluster | +| Argo CD | The live manifest in the cluster | The manifest in the git repository, which will be applied on sync | + +As an example, In the following images, the date of deployment was updated in a configmap by an Octopus deployment. + +:::figure +![ArgoCD Diff View](/docs/img/argo-cd/argo-cd-diff.png) +::: + +The same change, in Octopus will appear - note how the changes appear in opposite columns. + +:::figure +![Octopus Diff View](/docs/img/argo-cd/octopus-argo-cd-diff.png) +::: \ No newline at end of file