add release orchestrator docs and sprints gaps fills
This commit is contained in:
232
docs/modules/release-orchestrator/ui/screens.md
Normal file
232
docs/modules/release-orchestrator/ui/screens.md
Normal file
@@ -0,0 +1,232 @@
|
||||
# Key UI Screens
|
||||
|
||||
> Specification for key UI screens: Environment Overview, Release Detail, and Why Blocked modal.
|
||||
|
||||
**Status:** Planned (not yet implemented)
|
||||
**Source:** [Architecture Advisory Section 12.3](../../../product/advisories/09-Jan-2026%20-%20Stella%20Ops%20Orchestrator%20Architecture.md)
|
||||
**Related Modules:** [Environment Manager](../modules/environment-manager.md), [Release Manager](../modules/release-manager.md)
|
||||
**Sprints:** [111_002 - 111_007](../../../../implplan/)
|
||||
|
||||
## Overview
|
||||
|
||||
This document specifies the key UI screens for release orchestration.
|
||||
|
||||
---
|
||||
|
||||
## Environment Overview Screen
|
||||
|
||||
The environment overview shows the deployment pipeline and current state of each environment.
|
||||
|
||||
```
|
||||
+-----------------------------------------------------------------------------+
|
||||
| ENVIRONMENTS [+ New Environment] |
|
||||
+-----------------------------------------------------------------------------+
|
||||
| |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| | ENVIRONMENT PIPELINE | |
|
||||
| | | |
|
||||
| | +---------+ +---------+ +---------+ +---------+ | |
|
||||
| | | DEV | ---> | TEST | ---> | STAGE | ---> | PROD | | |
|
||||
| | | | | | | | | | | |
|
||||
| | | v2.4.0 | | v2.3.1 | | v2.3.1 | | v2.3.0 | | |
|
||||
| | | * 5 min | | * 2h | | * 1d | | * 3d | | |
|
||||
| | +---------+ +---------+ +---------+ +---------+ | |
|
||||
| | | |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| | PRODUCTION [Manage] [View] | |
|
||||
| | | |
|
||||
| | Current Release: myapp-v2.3.0 | |
|
||||
| | Deployed: 3 days ago by jane@example.com | |
|
||||
| | Targets: 5 healthy, 0 unhealthy | |
|
||||
| | | |
|
||||
| | +---------------------------------------------------------------+ | |
|
||||
| | | Pending Promotion: myapp-v2.3.1 [Review] | | |
|
||||
| | | Waiting: 2 approvals (1/2) | | |
|
||||
| | | Security: V All gates pass | | |
|
||||
| | +---------------------------------------------------------------+ | |
|
||||
| | | |
|
||||
| | Freeze Windows: None active | |
|
||||
| | Required Approvals: 2 | |
|
||||
| | | |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| |
|
||||
+-----------------------------------------------------------------------------+
|
||||
```
|
||||
|
||||
### Features
|
||||
|
||||
- **Environment Pipeline:** Visual flow showing version progression
|
||||
- **Environment Cards:** Detailed view of each environment
|
||||
- **Target Health:** Real-time target health indicators
|
||||
- **Pending Promotions:** Promotions awaiting action
|
||||
- **Freeze Windows:** Active and scheduled freeze windows
|
||||
- **Approval Status:** Current approval count vs required
|
||||
|
||||
---
|
||||
|
||||
## Release Detail Screen
|
||||
|
||||
The release detail screen shows all information about a specific release.
|
||||
|
||||
```
|
||||
+-----------------------------------------------------------------------------+
|
||||
| RELEASE: myapp-v2.3.1 |
|
||||
| Created: 2 hours ago by jane@example.com |
|
||||
+-----------------------------------------------------------------------------+
|
||||
| |
|
||||
| [Overview] [Components] [Security] [Deployments] [Evidence] |
|
||||
| |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| | COMPONENTS | |
|
||||
| | | |
|
||||
| | +------------------------------------------------------------------+ | |
|
||||
| | | api | | |
|
||||
| | | Version: 2.3.1 Digest: sha256:abc123... | | |
|
||||
| | | Security: V 0 critical, 0 high (0 reachable) | | |
|
||||
| | | Image: registry.example.com/myapp/api@sha256:abc123 | | |
|
||||
| | +------------------------------------------------------------------+ | |
|
||||
| | | |
|
||||
| | +------------------------------------------------------------------+ | |
|
||||
| | | worker | | |
|
||||
| | | Version: 2.3.1 Digest: sha256:def456... | | |
|
||||
| | | Security: V 0 critical, 0 high (0 reachable) | | |
|
||||
| | | Image: registry.example.com/myapp/worker@sha256:def456 | | |
|
||||
| | +------------------------------------------------------------------+ | |
|
||||
| | | |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| | DEPLOYMENT STATUS | |
|
||||
| | | |
|
||||
| | dev *--------------------------------------------* Deployed (2h) | |
|
||||
| | test *--------------------------------------------* Deployed (1h) | |
|
||||
| | stage o--------------------------------------------* Deploying... | |
|
||||
| | prod o Not deployed | |
|
||||
| | | |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| |
|
||||
| [Promote to Stage v] [Compare with Production] [Download Evidence] |
|
||||
| |
|
||||
+-----------------------------------------------------------------------------+
|
||||
```
|
||||
|
||||
### Tabs
|
||||
|
||||
1. **Overview:** Release metadata and summary
|
||||
2. **Components:** Component list with digests and versions
|
||||
3. **Security:** Vulnerability summary and reachability analysis
|
||||
4. **Deployments:** Deployment history across environments
|
||||
5. **Evidence:** Evidence packets for compliance
|
||||
|
||||
### Features
|
||||
|
||||
- **Digest Display:** Full OCI digests for each component
|
||||
- **Security Summary:** Vulnerability counts by severity
|
||||
- **Deployment Timeline:** Visual progress across environments
|
||||
- **Quick Actions:** Promote, compare, and export options
|
||||
|
||||
---
|
||||
|
||||
## "Why Blocked?" Modal
|
||||
|
||||
The "Why Blocked?" modal explains why a promotion cannot proceed.
|
||||
|
||||
```
|
||||
+-----------------------------------------------------------------------------+
|
||||
| WHY IS THIS PROMOTION BLOCKED? [Close] |
|
||||
+-----------------------------------------------------------------------------+
|
||||
| |
|
||||
| Release: myapp-v2.4.0 -> Production |
|
||||
| |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| | X SECURITY GATE FAILED | |
|
||||
| | | |
|
||||
| | Component 'api' has 1 critical reachable vulnerability: | |
|
||||
| | | |
|
||||
| | - CVE-2024-1234 (Critical, CVSS 9.8) | |
|
||||
| | Package: log4j 2.14.0 | |
|
||||
| | Reachability: V Confirmed reachable via api/logging/Logger.java | |
|
||||
| | Fixed in: 2.17.1 | |
|
||||
| | [View Details] [View Evidence] | |
|
||||
| | | |
|
||||
| | Remediation: Update log4j to version 2.17.1 or later | |
|
||||
| | | |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| | V APPROVAL GATE PASSED | |
|
||||
| | | |
|
||||
| | Required: 2 approvals | |
|
||||
| | Received: 2 approvals | |
|
||||
| | - john@example.com (2h ago): "LGTM" | |
|
||||
| | - sarah@example.com (1h ago): "Approved for prod" | |
|
||||
| | | |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| | V FREEZE WINDOW GATE PASSED | |
|
||||
| | | |
|
||||
| | No active freeze windows for production | |
|
||||
| | | |
|
||||
| +------------------------------------------------------------------------+ |
|
||||
| |
|
||||
| Policy evaluated at: 2026-01-09T14:32:15Z |
|
||||
| Policy hash: sha256:789xyz... |
|
||||
| [View Full Decision Record] |
|
||||
| |
|
||||
+-----------------------------------------------------------------------------+
|
||||
```
|
||||
|
||||
### Features
|
||||
|
||||
- **Gate-by-Gate Status:** Shows each gate with pass/fail status
|
||||
- **Failure Details:** Specific information about why a gate failed
|
||||
- **Vulnerability Details:** CVE info, package, version, and remediation
|
||||
- **Reachability Evidence:** Links to reachability analysis
|
||||
- **Approval History:** List of approvers and their comments
|
||||
- **Override Mechanism:** Request override for authorized users
|
||||
- **Decision Record:** Link to full evidence packet
|
||||
|
||||
---
|
||||
|
||||
## Navigation Structure
|
||||
|
||||
```
|
||||
Dashboard
|
||||
+-- Releases
|
||||
| +-- [Release Detail]
|
||||
| +-- Create Release
|
||||
| +-- Compare Releases
|
||||
|
|
||||
+-- Environments
|
||||
| +-- [Environment Overview]
|
||||
| +-- Create Environment
|
||||
| +-- Manage Targets
|
||||
|
|
||||
+-- Workflows
|
||||
| +-- [Workflow Editor]
|
||||
| +-- Workflow Runs
|
||||
| +-- Step Types
|
||||
|
|
||||
+-- Integrations
|
||||
| +-- Connectors
|
||||
| +-- Plugins
|
||||
| +-- Vault
|
||||
|
|
||||
+-- Settings
|
||||
+-- Users & Teams
|
||||
+-- Policies
|
||||
+-- Audit Log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## See Also
|
||||
|
||||
- [Dashboard](dashboard.md)
|
||||
- [Workflow Editor](workflow-editor.md)
|
||||
- [Environment Manager](../modules/environment-manager.md)
|
||||
- [Release Manager](../modules/release-manager.md)
|
||||
- [Promotion Manager](../modules/promotion-manager.md)
|
||||
Reference in New Issue
Block a user