Add Argo Rollouts documentation

dictionary-octopus.txt

@@ -454,6 +454,10 @@ rootelement
 Rootfs
 rsae
 RSASSA
+rollout
+rollouts
+Rollout
+Rollouts
 rstrip
 runbook
 runbookprocesses

src/pages/docs/kubernetes/argo-rollouts/control-actions.md

@@ -0,0 +1,94 @@
+---
+layout: src/layouts/Default.astro
+pubDate: 2026-05-03
+modDate: 2026-05-04
+title: Rollout control actions
+description: Pause, promote, and roll back Argo Rollouts directly from the Octopus UI.
+navOrder: 10
+---
+
+Octopus lets you control Argo Rollouts from the Rollout Details Drawer. Open the drawer by clicking the **⋮** menu next to a rollout resource on the Live Status dashboard and selecting **Details**. Control actions are gated by Octopus RBAC permissions.
+
+:::figure
+![The Rollout Details Drawer showing step-by-step progress, canary weight, AnalysisRun results, and control actions](/docs/img/kubernetes/argo-rollouts/rollout-details-drawer.png)
+:::
+
+:::div{.hint}
+Octopus does not create, edit, or delete Rollout definitions. Rollout specs continue to be managed via Git or Helm charts.
+:::
+
+## Available actions
+
+The actions available depend on the current state of the rollout.
+
+| Action | Description | Available when |
+| :--- | :--- | :--- |
+| **Details** | Opens the Rollout Details Drawer | Always |
+| **Pause** | Halts progression at the current step | Rollout is in progress |
+| **Promote** | Advances the rollout to the next step | Rollout is paused at a step |
+| **Promote Full** | Skips all remaining steps and promotes to 100% immediately | Rollout is paused at a step |
+| **Restart** | Restarts the pods in the rollout | Rollout is in progress or paused |
+| **Retry** | Retries a failed rollout from the current step | Rollout is degraded |
+| **Abort** | Aborts the rollout and scales down the canary or preview ReplicaSet | Rollout is in progress or paused |
+| **Rollback** | Reverts to the previous stable ReplicaSet | Any state |
+
+## Pause
+
+Pausing a rollout halts progression at the current step. No additional traffic weight changes or analysis steps are executed while the rollout is paused.
+
+The rollout moves to a **Paused** state. The current canary weight or blue-green preview state is held until you promote, resume, abort, or roll back.
+
+## Promote
+
+Promotes the rollout to the next step in the rollout spec. Use this when a rollout is paused at a step waiting for manual approval before continuing.
+
+For canary rollouts, promoting advances to the next weight step or analysis step. For blue-green rollouts, promoting switches traffic from the preview to the active ReplicaSet.
+
+## Promote Full
+
+Skips all remaining steps and immediately promotes the rollout to 100%. For canary deployments this means the canary ReplicaSet receives 100% of traffic. For blue-green deployments this completes the switch immediately.
+
+:::div{.warning}
+Promote Full bypasses any remaining analysis steps. Use with caution in production environments.
+:::
+
+## Restart
+
+Triggers a rolling restart of the pods in the rollout's current ReplicaSet. This is equivalent to `kubectl rollout restart` and is useful for picking up configuration changes (such as updated ConfigMaps or Secrets) without changing the rollout's traffic split.
+
+## Retry
+
+Available when a rollout is in a **Degraded** state. Retries the rollout from the current failed step without reverting traffic.
+
+## Abort
+
+Aborts an in-progress or paused rollout. Argo Rollouts scales down the canary or preview ReplicaSet and restores 100% of traffic to the stable ReplicaSet. The rollout moves to a **Degraded** state.
+
+## Rollback
+
+Reverts to the previous stable ReplicaSet. Available in any state, including after a completed rollout.
+
+:::div{.warning}
+Rollback is not the same as re-deploying a previous release. To re-deploy an earlier version, create a new release in Octopus with the desired package version.
+:::
+
+## Permissions
+
+Control actions are gated by Octopus permissions. Users with read-only access can view rollout state but cannot perform any actions.
+
+| Action | Required permission |
+| :--- | :--- |
+| View rollout status and details | Project `View` |
+| Pause, Promote, Promote Full, Restart, Retry, Abort, Rollback | Project `DeploymentCreate` |
+
+When [tenanted deployments](/docs/tenants) are in use, rollout control actions are scoped to the tenant.
+
+## Audit log
+
+All control actions performed through the Octopus UI are recorded in the [Octopus audit log](/docs/security/users-and-teams/auditing). Each entry includes the user, the rollout target, and the timestamp.
+
+## Learn more
+
+- [Argo Rollouts overview](/docs/kubernetes/argo-rollouts)
+- [Live Object Status](/docs/kubernetes/live-object-status)
+- [Auditing](/docs/security/users-and-teams/auditing)

src/pages/docs/kubernetes/argo-rollouts/index.md

@@ -0,0 +1,120 @@
+---
+layout: src/layouts/Default.astro
+pubDate: 2026-05-03
+modDate: 2026-05-03
+title: Argo Rollouts in Octopus
+navTitle: Overview
+navSection: Argo Rollouts
+description: Monitor and control Argo Rollouts progressive delivery strategies directly within the Octopus UI.
+navOrder: 35
+hideInThisSectionHeader: true
+---
+
+Octopus provides native visualization and control for [Argo Rollouts](https://argoproj.github.io/rollouts/), letting you monitor progressive delivery strategies and perform key operational actions—pause, promote, rollback, and more—without leaving the Octopus UI.
+
+Argo Rollouts is a Kubernetes controller that enables blue-green and canary deployment strategies with fine-grained traffic control, automated analysis, and instant rollback. It is a CNCF Graduated project.
+
+:::div{.hint}
+Octopus supports **visualization and control** of Argo Rollouts. Rollout definitions continue to be authored and managed via Git or Helm charts—the standard GitOps workflow.
+:::
+
+## Supported deployment paths
+
+Argo Rollouts support is available for both Octopus Kubernetes deployment paths:
+
+| Deployment path | Supported |
+| :--- | :---: |
+| [Kubernetes Agent](/docs/kubernetes/targets/kubernetes-agent) (without Argo CD) | ✓ |
+| [Argo CD Gateway](/docs/argo-cd) | ✓ |
+
+Deployments that do not deploy Rollout resources are unaffected—rollout UI elements are hidden automatically.
+
+## Prerequisites
+
+- Argo Rollouts CRDs and controller installed in your target cluster(s)
+- A connected Kubernetes Agent or Argo CD Gateway deployment target in Octopus
+- At least one Argo `Rollout` resource deployed to a cluster that Octopus manages
+
+## Deployment behavior
+
+When a deployment includes a Rollout resource, Octopus waits for the rollout to complete before marking the deployment step as successful. This means the deployment task remains in progress while the rollout progresses through its steps, including any canary weight increments and AnalysisRuns.
+
+## Project Dashboard rollout status
+
+Rollout status is shown on the Project Dashboard only while a deployment is in progress. Once a deployment completes, rollout information is no longer highlighted in the dashboard view.
+
+During a deployment, each environment column displays live rollout-aware status indicators using rollout-specific states:
+
+:::figure
+![The Live Status dashboard showing an active canary rollout with traffic split and action menu](/docs/img/kubernetes/argo-rollouts/rollout-active-canary.png)
+:::
+
+| State | Meaning |
+| :--- | :--- |
+| Healthy | All rollouts are complete and stable |
+| In Progress | A rollout is actively progressing through steps |
+| Paused | A rollout is paused, awaiting manual promotion or analysis |
+| Degraded | A rollout has failed or an AnalysisRun did not pass |
+| Unknown | Rollout state cannot be determined |
+
+A summary row shows the count of active rollouts per environment. Click any status indicator to open the rollout popover.
+
+## Rollouts popover
+
+Clicking a rollout status indicator opens a popover with an at-a-glance summary of the rollout without leaving the dashboard:
+
+- **Strategy**: canary or blue-green
+- **Current status** and step progression
+- **Canary weight** (canary strategy) or active/preview state (blue-green strategy)
+- **Validation results** from any AnalysisRuns
+
+Click **View details** in the popover to open the full Rollout Details Drawer.
+
+:::figure
+![The rollout popover showing strategy, status, step progression, and canary weight](/docs/img/kubernetes/argo-rollouts/rollout-popover.png)
+:::
+
+## Rollout Details Drawer
+
+The Rollout Details Drawer provides full visibility into a single rollout. It slides in over the dashboard without navigating away from your current context.
+
+The drawer shows:
+
+- **Step-by-step progress**: each rollout step with its current status
+- **Canary weight** percentages or blue-green switch state
+- **AnalysisRun results**: pass/fail status per analysis metric, including inputs and titles for reused analysis templates
+- **ReplicaSet details**: active and preview/canary ReplicaSets with pod counts and health
+- **Control actions**: Pause, Resume, and Rollback buttons (visible based on your Octopus permissions)
+
+See [Rollout control actions](/docs/kubernetes/argo-rollouts/control-actions) for details on all available actions.
+
+:::figure
+![The Rollout Details Drawer showing step-by-step progress, canary weight, AnalysisRun results, and control actions](/docs/img/kubernetes/argo-rollouts/rollout-details-drawer.png)
+:::
+
+## Task Log integration
+
+Rollout progress is reflected in the Releases **Task Log** as expandable items alongside other deployment steps. This lets you correlate rollout events with the rest of your deployment in chronological order.
+
+Each rollout item in the task log shows:
+
+- The rollout step name and status
+- Timing information
+- Expandable detail with log output and AnalysisRun results for that step
+
+This is useful during incidents, where you need to correlate rollout progress against the timestamp of an anomaly detected in your monitoring tools.
+
+## RBAC
+
+Rollout status is visible to any user with read access to the project and environment.
+
+Control actions (pause, resume, rollback) require the appropriate Octopus permissions. Users without control permissions see a read-only view of rollout state. All control actions are recorded in the Octopus audit log.
+
+See [Rollout control actions](/docs/kubernetes/argo-rollouts/control-actions) for the full permissions reference.
+
+## Learn more
+
+- [Rollout control actions](/docs/kubernetes/argo-rollouts/control-actions)
+- [Live Object Status](/docs/kubernetes/live-object-status)
+- [Argo CD deployments with Octopus](/docs/argo-cd)
+- [Kubernetes Agent](/docs/kubernetes/targets/kubernetes-agent)