About Cockpit - cockpit-project/cockpit GitHub Wiki

Issue : As a user, I would like the "About Cockpit" to provide the versions of all modules.

Use cases

• List of all installed packages in cockpit with version number, guide
• Along with the version, a link to the pages with release notes or pages with details of issues open and fixed in various versions.

User Stories

Ryan Jacobs Ryan is a newy appointed sys-admin with a small IT organization based out of New Jersey. He has been a part of several different companies outside and has worn many hats. Currently, he is appointed as a senior sys-admin of his company and is frequent user of the terminal to administer the server. He tries to get all his information through the terminal itself. Of late his company has been in the process of using a web based interface for administering a server. His developer encounters some problems while using a cockpit module installed on that server. Ryan wants to help the developer get to the root cause of this problem.

Anna Marie Anna is a front end developer working for a multinational IT company. Her day to day responsibilities include developing a web app, posting issues and resolving them in github. Since her team’s sys-admin left the company, she decides to help and work as a part-time sys-admin. She is not very familiar with the web interface her company has been using for the administering the server. However she decides upon herself to educate about the interface, thinking that it might help her understand the process from end to end. She has recently finished developing a web-app and is facing some issues with the Atomic Registry running on this server. She wants to get to the bottom of this issue and resolve it.

Workflows

Ryan Jacob Ryan logs into the cockpit and checks out the about page. It shows him a list of all the modules installed and their versions. It also provides him with links to pages to file issues for these modules. It also shows him the Cockpit version number and the hostname,OS in which it is currently being configured.Ryan provides this information to the developer and the developer is now able to successfully file an issue with relevant details about the module(s) he is running.

Anna Marie Anna logs into Cockpit. She could have logged into the server via the terminal, but chooses to give Cockpit a shot. She notices the About Cockit page and goes to it. There it shows her the version of Atomic registry running on her server. She finds a link there to a page that is able to give more information about the issues present in her installed version. That page also indicates that the issue is fixed in the next version. The next version with these fixes has been released as well. Anna immediately chooses to update the version of Atomic registry she is running and here issue gets resolved.

##Wireframes

First iteration of the wireframe

Second iteration of the wireframe

User Stories

Feedback

• A session can be connected to multiple machines and run different versions of the modules: Cockpit loads the actual pages from the system the user is currently configuring. To solve this, the About dialog probably has to be contextual to show pertinent information.
• In a first step we should make sure to display what machine this info is referring to (e.g. hostname, OS)
• Example: While accessing the docker (containers) package on machine X, I will want to see the machine name (X), versions for docker and cockpit as installed on X