Features/EmptyTemplate

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
(Undo revision 181276 by Arcress (Talk))
(revert to original template)
Line 12: Line 12:
  
 
= Feature Name <!-- The name of your feature --> =
 
= Feature Name <!-- The name of your feature --> =
IPMIUTIL
 
  
 
== Summary ==
 
== Summary ==
 
<!-- A sentence or two summarizing what this feature is and what it will do.  This information is used for the overall feature summary page for each release. -->
 
<!-- A sentence or two summarizing what this feature is and what it will do.  This information is used for the overall feature summary page for each release. -->
An easy-to-use fully-featured IPMI server management utility. 
 
  
 
== Owner ==
 
== Owner ==
 
<!--This should link to your home wiki page so we know who you are-->
 
<!--This should link to your home wiki page so we know who you are-->
* Name: Andy Cress
+
* Name: [[User:FASAcountName| Your Name]]
  
 
<!-- Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or  technical issues need to be resolved-->
 
<!-- Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or  technical issues need to be resolved-->
* Email: arcress@users.sourceforge.net
+
* Email: <your email address so we can contact you, invite you to meetings, etc.>
  
 
== Current status ==
 
== Current status ==
* Targeted release: Releases/14
+
* Targeted release: [[Releases/{{FedoraVersion||next}} | {{FedoraVersion|long|next}} ]]
* Last updated: 11 June 2010
+
* Last updated: (DATE)
* Percentage of completion: 95%
+
* Percentage of completion: XX%
  
 
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
 
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
  
 
== Detailed Description ==
 
== Detailed Description ==
IPMIUTIL performs a series of common IPMI server management functions to allow administrators to perform management functions without a learning curve.  It can gather FRU inventory data, SEL firmware log, sensors, watchdog, power control, health, monitoring, and has an SOL console.  It can write sensor thresholds, FRU asset tags, and supports a full IPMI configuration save/restore.  Ease-of-use examples with IPMIUTIL:  configuring the IPMI LAN requires a single command, and a soft-reboot can be easily performed instead of a hard rebootThis utility can use various existing IPMI drivers, or run in driverless mode, which is useful for boot media or test environments.  The decoding of IPMI events includes a severity, and any events not recognized at least return the data, rather than just ‘Unknown’.  Features compared to other IPMI packages: http://ipmiutil.sourceforge.net/docs/ipmisw-compare.htm
+
<!-- Expand on the summary, if appropriateA couple sentences suffices to explain the goal, but the more details you can provide the better. -->
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
This is a new project for Fedora.  Previous IPMI management features in Fedora were oriented bottom-up, providing IPMI features, but requiring previous IPMI knowledge and many commands to accomplish common tasks. IPMIUTIL detects defaults rather than requiring them as input.  It has an existing following of users who see its benefits over other IPMI projects.
+
<!-- What is the benefit to the platform? If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Fedora become a better distribution or project because of this feature?-->
  
 
== Scope ==
 
== Scope ==
Upstream Project: http://ipmiutil.sourceforge.net/
+
<!-- What work do the developers 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?-->
List of Bugs upstream: http://sourceforge.net/tracker/?group_id=116222&func=browse
+
Features compared to other IPMI packages: http://ipmiutil.sourceforge.net/docs/ipmisw-compare.htm
+
Additonal automated test scripts need to be added (<=5%)
+
  
 
== How To Test ==
 
== How To Test ==
Hardware:
+
<!-- This does not need to be a full-fledged documentDescribe the dimensions of tests that this feature is expected to pass when it is doneIf it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.
This utility should be tested both locally and via IPMI LAN to the target.
+
There should be more than one vendor's IPMI firmware tested, for example: Intel, SuperMicro, Dell, etc.  It works with both standard servers and bladed ATCA servers. 
+
Software:
+
It runs with or without a driver on any IPMI-compliant serverThere is an existing unit test script in the project (unittest.sh) which checks minimal functionality for each area, and a more detailed automated test script is under development (testipmi.sh)These scripts detect PASS/FAIL and abort if errors are encountered.  The scripts can be modified if desired to add additional tests.
+
To test remote IPMI LAN capability via testipmi.sh, the target server should first be prepared by installing ipmiutil and doing:
+
  # ipmiutil lan -e -I <bmc_ip> -u admin -p password
+
  # service ipmiutil_asy start
+
  
== User Experience ==
+
Remember that you are writing this how to for interested testers to use to check out your feature - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your feature.
ipmiutil  = the command-line utility to perform various IPMI management functions, see man pages for details.
+
  
checksel  = a daily cron script to manage the IPMI SEL, copying records to syslog, and clearing it if full.
+
A good "how to test" should answer these four questions:
  
ipmi_port = a service to bind RMCP port 623 to prevent portmap from using it
+
0. What special hardware / data / etc. is needed (if any)?
 +
1. How do I prepare my system to test this feature? What packages
 +
need to be installed, config files edited, etc.?
 +
2. What specific actions do I perform to check that the feature is
 +
working like it's supposed to?
 +
3. What are the expected results of those actions?
 +
-->
  
ipmiutil_asy = a service to listen for async bridge requests, like soft-reboot
+
== User Experience ==
 
+
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
ipmiutil_wdt = a service to reset the IPMI watchdog every 60 seconds
+
 
+
libipmiutil.a = a library built in the source tree to build custom apps
+
 
+
ipmi_sample  = a sample custom app using libipmiutil.a
+
  
 
== Dependencies ==
 
== Dependencies ==
Does not depend on any external software packages, but will use any of several ipmi drivers, if running locally and the driver is loaded. 
+
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
  
 
== Contingency Plan ==
 
== Contingency Plan ==
None necessary.
+
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
  
 
== Documentation ==
 
== Documentation ==
* UserGuide http://ipmiutil.sourceforge.net/docs/UserGuide
+
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
* Feature comparison http://ipmiutil.sourceforge.net/docs/ipmisw-compare.htm
+
*
* List of Bugs upstream: http://sourceforge.net/tracker/?group_id=116222&func=browse
+
  
 
== Release Notes ==
 
== Release Notes ==
 
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
* Adds ipmiutil package for easy-to-use management on IPMI servers. Includes default detection of various parameters, making the provisioning and IPMI LAN remote connections much easier.  Includes optional services to automate IPMI management.
+
*
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
* See Talk:Features/ipmiutil or http://lists.sourceforge.net/lists/listinfo/ipmiutil-developers
+
* See [[Talk:Features/YourFeatureName]]  <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
 +
 
  
 
[[Category:FeaturePageIncomplete]]
 
[[Category:FeaturePageIncomplete]]

Revision as of 21:11, 22 June 2010

Important.png
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 "edit" link.
Copy the source to a new page before making changes! DO NOT EDIT THIS TEMPLATE FOR YOUR FEATURE.
Important.png
Set a Page Watch
Make sure you click watch on your new page so that you are notified of changes to it by others, including the Feature Wrangler
Note.png
All sections of this template are required for review by FESCo. If any sections are empty it will not be reviewed



Contents

Feature Name

Summary

Owner

  • Email: <your email address so we can contact you, invite you to meetings, etc.>

Current status

  • Targeted release: Fedora 21
  • Last updated: (DATE)
  • Percentage of completion: XX%


Detailed Description

Benefit to Fedora

Scope

How To Test

User Experience

Dependencies

Contingency Plan

Documentation

Release Notes

Comments and Discussion