From Fedora Project Wiki
(Created page with "{{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To re...")
 
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To read it, choose the "view source" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR CHANGE PROPOSAL.'''}}
<!-- Self Contained or System Wide Change Proposal?
<!-- Self Contained or System Wide Change Proposal?
Use this guide to determine to which category your proposed change belongs to.
Use this guide to determine to which category your proposed change belongs to.
Line 26: Line 24:


== Summary ==
== Summary ==
sen is a tool, similar to htop, alot or tig, which runs in terminal exclusively. It enables you to manage your containers and images interactively directly from command line.
sen enables you to manage your containers and images interactively directly from command line. Interface is similar to [https://admin.fedoraproject.org/pkgdb/package/htop/ htop], [https://admin.fedoraproject.org/pkgdb/package/alot/ alot] or [https://admin.fedoraproject.org/pkgdb/package/tig/ tig].


== Owner ==
== Owner ==
Line 36: Line 34:
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
* Email: ttomecek@redhat.com
* Email: ttomecek@redhat.com
* Release notes owner: <!--- To be assigned by docs team [[User:FASAccountName| Release notes owner name]] <email address> -->
* Release notes owner: <!--- To be assigned by docs team [[User:FASAccountName| Release notes owner name]] <email address> -->[mailto:sclark@fedoraproject.org Simon Clark] ([[User:sclark|sclark]])
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
Line 54: Line 52:
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
-->
-->
* Tracker bug: <will be assigned by the Wrangler>
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=1292683 #1292683]


== Detailed Description ==
== Detailed Description ==
Line 60: Line 58:
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->


TBD
Features:
 
* it can interactively manage your containers and images:
** manage? start, stop, restart, kill, delete,...
* you are able to inspect containers and images
* sen can fetch logs of containers and even stream logs real-time
* all buffers support searching and filtering
* sen receives real-time updates from docker when anything changes
** e.g. if you create a container in another terminal, sen will pick it up
* sen notifies you whenever something happens (and reports slow queries)
* supports a lot of vim-like keybindings (j, k, gg, /, ...)
 
[[File:Sen-preview.gif]]


== Benefit to Fedora ==
== Benefit to Fedora ==


TBD
Fedora will be probably the first distribution having sen natively packaged. Benefit is the possibility to manage containers and images interactively instead of manual <code>docker</code> cli usage.


<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new functionality, what capabilities does it bring? Why will Fedora become a better distribution or project because of this proposal?-->
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new functionality, what capabilities does it bring? Why will Fedora become a better distribution or project because of this proposal?-->
Line 71: Line 81:
* Proposal owners:
* Proposal owners:
<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
** package sen to Fedora
** package sen to Fedora: https://bugzilla.redhat.com/show_bug.cgi?id=1290345 DONE
** provide a documentation how to use it (maybe via developer portal?)
** provide an information it's available and documentation how to use it -- via developer portal -- PR is submitted https://github.com/developer-portal/content/pull/118


* Other developers: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Other developers: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
Line 110: Line 120:
-->
-->


1. sudo dnf install sen
<pre>
2. sudo systemctl start docker
$ sudo dnf install sen
2. sen
$ sudo systemctl start docker
$ sen
</pre>


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
Line 120: Line 132:
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->


docker ps
<pre>
docker images
$ docker ps
docker inspect
$ docker images
docker logs
$ docker inspect
$ docker logs
</pre>


vs.
vs.


sen
<pre>
$ sen
arrow down
arrow down
arrow up
arrow up
i
i
l
l
</pre>


== Dependencies ==
== Dependencies ==
Line 153: Line 169:


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
N/A (not a System Wide Change)
[https://github.com/TomasTomecek/sen/blob/master/README.md]


== Release Notes ==
== Release Notes ==
Line 162: Line 178:
-->
-->


[[Category:ChangePageIncomplete]]
[[Category:ChangeAcceptedF24]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->

Latest revision as of 12:05, 30 April 2016


sen: terminal user interface for docker engine

Summary

sen enables you to manage your containers and images interactively directly from command line. Interface is similar to htop, alot or tig.

Owner

Current status

Detailed Description

Features:

  • it can interactively manage your containers and images:
    • manage? start, stop, restart, kill, delete,...
  • you are able to inspect containers and images
  • sen can fetch logs of containers and even stream logs real-time
  • all buffers support searching and filtering
  • sen receives real-time updates from docker when anything changes
    • e.g. if you create a container in another terminal, sen will pick it up
  • sen notifies you whenever something happens (and reports slow queries)
  • supports a lot of vim-like keybindings (j, k, gg, /, ...)

Sen-preview.gif

Benefit to Fedora

Fedora will be probably the first distribution having sen natively packaged. Benefit is the possibility to manage containers and images interactively instead of manual docker cli usage.


Scope

  • Other developers: N/A (not a System Wide Change)
  • Release engineering: N/A (not a System Wide Change)
  • Policies and guidelines: N/A (not a System Wide Change)
  • Trademark approval: N/A (not needed for this Change)

Upgrade/compatibility impact

N/A (not a System Wide Change)

How To Test

$ sudo dnf install sen
$ sudo systemctl start docker
$ sen


User Experience

$ docker ps
$ docker images
$ docker inspect
$ docker logs

vs.

$ sen
arrow down
arrow up
i
l

Dependencies

N/A (not a System Wide Change)

Contingency Plan

  • Contingency mechanism: (What to do? Who will do it?) N/A (not a System Wide Change)
  • Contingency deadline: N/A (not a System Wide Change)
  • Blocks release? No
  • Blocks product? No

Documentation

[1]

Release Notes