Skip to content
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

docs: update to issues roadmap #40

Merged
merged 1 commit into from
Jul 8, 2024
Merged

docs: update to issues roadmap #40

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
41 changes: 17 additions & 24 deletions ISSUES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,22 @@
# Issues

# Images
- Run Image
- New Image
- Tag Image
This documents forms the basis of an approximately prioritised high level roadmap for Ducker.

# Exec
- Add modal to provide exec command when exec-ing into a container
The "issues" listed here are the aspirational set of features I have in mind, sorted into approximate priority/dependency order (I can't really add much in the way of modals until I've got my direction straight with modals).

# Logs
- Choose log time range
Feel free to raise issues in github.

# In Depth View
- Add extra detail to describe view

# Filesystems
- Access image/container filesystem & get file

# Modals
- Modals to use trait objects
- General purpose modals for errors

# Other/Tech Debt
- Fix callbacks to use closures
- Add filter widget/component (similar to vim searching)
- Option to control container log time ranges
- Add tracing of some sort

# Not currently in scope
- Swarm specific features
- Automated test strategy; perhaps obviously there aren't any tests in the repo. This is due to the way in which the project started, but probably needs to change sooner rather than later!
- Add volumes as a first class citizen
- Add networks as a first class citizen
- Modals should use a general purpose trait object of some sort - preferably only one modal field per page, in a similar way to pages in the page manager
- Support for "forms" of scrolling stateful widgets (TODO - look out for ratatui libraries that already support this)
- Run Images - Given an image, run a new container; provide a form/modal to allow user to configure the container
- Tag Image - Allow a user to re-tag an image & push the re-tagged image
- Add extra detail to describe view - it is currently more representative of a PoC as it doesn't include much information not already in the table.
- CPU/network trace in detail page for container
- Callbacks should use closures instead of boilerplate-heavy structs
- Add filters to list pages
- vitepress docs page
23 changes: 11 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,10 @@

## Installation

<p align="center">
❗ Note: Ducker is currently in a "pre-release" state. ❗
<br/>
Please do install and try it out - it is currently undergoing active development. There are a number of known issues and features in the pipeline (<a href="https://github.com/robertpsoane/ducker/issues/2">see the pinned issue</a>). Any feedback is welcome.
</p>
> :warning: **Ducker is currently in a "pre-release" state**: Please do install and try it out - it is currently undergoing active development.
>
> There are a number of known issues and features in the pipeline (See [the pinned issue](https://github.com/robertpsoane/ducker/issues/2) and [ISSUES.md](./ISSUES.md) for more info). Any feedback and suggestions are welcome.



### Cargo
Expand Down Expand Up @@ -129,13 +128,13 @@ Ducker is configured via a yaml file found in the relevant config directory for

The following table summarises the available config values:

| Key | Default | Description |
| ---------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| prompt | 🦆 | The default prompt to display in the command pane |
| default_exec | `/bin/bash` | The default prompt to display in the command pane. NB - currently uses this for all exec's; it is planned to offer a choice |
| docker_path | `unix:///var/run/docker.sock` | The location of the socket on which the docker daemon is exposed (defaults to `npipe:////./pipe/docker_engine` on windows) |
| check_for_update | `true` | When true, checks whether there is a newer version on load. If a newer version is found, indicates via note in bottom right.* |
| theme | [See below] | The colour theme configuration |
| Key | Default | Description |
| ---------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| prompt | 🦆 | The default prompt to display in the command pane |
| default_exec | `/bin/bash` | The default prompt to display in the command pane. NB - currently uses this for all exec's; it is planned to offer a choice |
| docker_path | `unix:///var/run/docker.sock` | The location of the socket on which the docker daemon is exposed (defaults to `npipe:////./pipe/docker_engine` on windows) |
| check_for_update | `true` | When true, checks whether there is a newer version on load. If a newer version is found, indicates via note in bottom right. |
| theme | [See below] | The colour theme configuration |

> :warning: **`check_for_update` is not available in v0.0.5 and below as released on cargo**: to use this feature, install the unstable build or await next release

Expand Down