Skip to content

docs: update README and PRD for SSH, console, clone features #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
larkly merged 1 commit into from
Mar 29, 2026
Merged

docs: update README and PRD for SSH, console, clone features #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions PRD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
| Phase 2: Extended Compute | ✓ Complete | All actions, console log, resize, bulk ops, action history |
| Phase 3: Additional Resources | ✓ Complete | Tabbed navigation, volumes, floating IPs, security groups, key pairs, networks (CRUD), routers (CRUD) |
| Phase 4: Refactor, Octavia, Projects, Quotas | ✓ Complete | App refactor, dynamic tabs, Octavia LB tab, project switching, quota overlay |
| Phase 5: Quality of Life | Partial | Server rename, rebuild, snapshot, rescue/unrescue, image management, confirmation dialogs for all actions — done. SSH, clipboard, config file, DNS — not started |
| Phase 5: Quality of Life | Partial | Server rename, rebuild, snapshot, rescue/unrescue, image management, confirmation dialogs for all actions, SSH integration, console access (noVNC), server cloning, cross-resource navigation — done. Clipboard (general), config file, DNS — not started |
| Phase 6: Operational | Not started | Admin views, hypervisor view, service catalog browser |

## Concerns and Considerations
Expand Down Expand Up @@ -738,7 +738,7 @@ Actions available in Nova but not yet implemented, prioritized by usefulness:
- ~~**Rescue/Unrescue**~~: ✓ Complete — `Ctrl+W`, toggle rescue mode

#### Medium-value (specific scenarios)
- **Console access (noVNC)** — Retrieve and open VNC console URL. Text console log exists but graphical console does not.
- ~~**Console access (noVNC)**~~ ✓ Done — Retrieve and open VNC console URL via `V` key. Opens in browser or copies to clipboard.
- **Get password** — Retrieve auto-generated password for Windows VMs (`servers.GetPassword`).

#### Admin-only (Phase 6)
Expand All @@ -753,11 +753,11 @@ Actions available in Nova but not yet implemented, prioritized by usefulness:
- Custom column selection and ordering
- Saved filters
- Server name templates for create
- SSH integration (launch SSH session to selected server)
- Copy-to-clipboard for IDs, IPs
- ~~SSH integration (launch SSH session to selected server)~~ ✓ Done (#27)
- Copy-to-clipboard for IDs, IPs (general — SSH command copy done via `y`)
- Log/audit trail of actions taken
- Designate (DNS) tab
- Console access (noVNC URL retrieval and browser launch)
- ~~Console access (noVNC URL retrieval and browser launch)~~ ✓ Done (#50)

### Phase 6: Operational
- Hypervisor view (admin)
Expand Down
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ Single binary. No runtime dependencies. Reads your standard `clouds.yaml`.
- **Confirmation dialogs** — all server state-change actions require explicit confirmation
- **Dynamic tabs** — tabs appear based on available services (no Cinder? no Volumes tab)
- **Auto-refresh** — all views refresh in the background at a configurable interval
- **SSH integration** — launch SSH sessions directly from the TUI, or copy the SSH command to clipboard
- **Console access** — retrieve noVNC console URL, open in browser or copy to clipboard
- **Server cloning** — clone servers with one keypress
- **Cross-resource navigation** — jump from server detail to attached volumes, security groups, or networks
- **Console log** and **action history** per server
- **Column sorting** on all list views
- **Client-side filtering** with `/`
Expand Down Expand Up @@ -162,6 +166,10 @@ No additional configuration is needed. If only one cloud is defined, lazystack c
| `r` | Rename |
| `Ctrl+G` | Rebuild with new image |
| `Ctrl+S` | Create snapshot |
| `c` | Clone server |
| `x` | SSH into server |
| `y` | Copy SSH command |
| `V` | Console URL (noVNC) |
| `L` | Console log |
| `a` | Action history |

Expand All @@ -184,6 +192,13 @@ No additional configuration is needed. If only one cloud is defined, lazystack c
| `r` | Rename |
| `Ctrl+G` | Rebuild with new image |
| `Ctrl+S` | Create snapshot |
| `c` | Clone server |
| `x` | SSH into server |
| `y` | Copy SSH command |
| `V` | Console URL (noVNC) |
| `v` | Jump to volumes |
| `g` | Jump to security groups |
| `N` | Jump to networks |
| `L` | Console log |
| `a` | Action history |
| `Esc` | Back to list |
Expand Down