From FedoraProject
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 "edit" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR FEATURE.'''}}
 
  
{{admon/important | 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}}
+
= YumCron =
 
 
{{admon/note | All sections of this template are required for review by FESCo.  If any sections are empty it will not be reviewed }}
 
 
 
 
 
<!-- All fields on this form are required to be accepted by FESCo.
 
We also request that you maintain the same order of sections so that all of the feature pages are uniform.  -->
 
 
 
<!-- The actual name of your feature page should look something like: Features/Your_Feature_Name.  This keeps all features in the same namespace -->
 
 
 
= YumCron <!-- The name of your feature --> =
 
  
 
== 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. -->
 +
Yum Cron is a program that is designed to be run as a cron job to automatically preform common yum tasks.  These tasks include refreshing the repository metadata, and checking for, downloading, and installing package updates.
 +
  
 
== Owner ==
 
== Owner ==
<!--This should link to your home wiki page so we know who you are-->
+
* Name: [[User:njacek| Nick Jacek]]
* Name: [[User:FASAcountName| Your Name]]
+
* Email: <njacek@redhat.com>
 
 
<!-- 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: <your email address so we can contact you, invite you to meetings, etc.>
 
  
 
== Current status ==
 
== Current status ==
* Targeted release: [[Releases/<number> | Fedora <number> ]]  
+
* Targeted release: [[Releases/18 | Fedora 18 ]]  
* Last updated: (DATE)
+
* Last updated: 2012-06-26
* Percentage of completion: XX%
+
* Percentage of completion: 10%
  
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
+
== Detailed Description ==
 +
The goal of this feature is to provide a single convenient way for users to automate common yum tasks.  YumCron will provide the means to:
 +
* Refresh repository metadata.  Then, when users run yum, they will not have to wait for metadata to be downloaded, providing a more responsive experience.
 +
* Check for updates, and alert users that updates are available for their system.
 +
* Download available updates.  Users who wish to apply updates manually will then be able to do so more quickly and conveniently, as they will not have to wait for the updates to be downloaded.
 +
* Install updates automatically.
  
== Detailed Description ==
 
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
 
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
<!-- 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?-->
+
Previously, yum-updatesd and yum-cron were available to automate certain yum tasks.  However, these did not provide all the capabilities that users required, and were difficult to use and maintain. In particular, yum-cron simply provided a wrapper to the yum command line interface, making it difficult to access different capabilities and options. This feature will unify and extend yum-updatesd and yum-cron to provide a single, clear, consistent way to automate yum tasks.  This will benefit Fedora users and administrators by making it much more simple and convenient to keep their systems up to date.
 +
 
  
 
== Scope ==
 
== Scope ==
 
<!-- 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?-->
 
<!-- 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?-->
 +
This is a relatively isolated change.  It should have minimal impact on the rest of the distribution, as it will not perform any functions that could not be done manually with yum.
 +
 +
* Implement functionality to check, download and install updates
 +
* Implement methods to emit messages to users about available updates and the operation of the program
 +
* Submit package for inclusion in Fedora
 +
* Perform testing and bug fixes
  
 
== How To Test ==
 
== How To Test ==
<!-- This does not need to be a full-fledged document.  Describe the dimensions of tests that this feature is expected to pass when it is done.  If 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.  
+
* Configure yum-cron.conf to preform the desired actions
 
+
* Run yum-cron manually, or set it to be run as a cron job.
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.
+
* Check that the requested actions are performed to check for, download, or install updates.
 
 
A good "how to test" should answer these four questions:
 
 
 
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?
 
-->
 
  
 
== User Experience ==
 
== 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. -->
+
Users will be able to configure YumCron to perform various functions.  Then, the feature will be run as a cron job to perform the requested actions. Users will be notified about the operation of this program according to the method that they select in the configuration file.
  
 
== Dependencies ==
 
== Dependencies ==
<!-- 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)? -->
+
No other packages depend on this package.
 +
 
  
 
== Contingency Plan ==
 
== Contingency Plan ==
<!-- 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. -->
+
No contingency plan is needed, we can revert to the previous release behavior of yum and yum-updatesd.
  
 
== Documentation ==
 
== Documentation ==
Line 70: Line 59:
 
<!-- 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. -->
*
+
* YumCron provides a simple way to automate common yum tasks.
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==

Revision as of 19:29, 26 June 2012

YumCron

Summary

Yum Cron is a program that is designed to be run as a cron job to automatically preform common yum tasks. These tasks include refreshing the repository metadata, and checking for, downloading, and installing package updates.


Owner

Current status

  • Targeted release: Fedora 18
  • Last updated: 2012-06-26
  • Percentage of completion: 10%

Detailed Description

The goal of this feature is to provide a single convenient way for users to automate common yum tasks. YumCron will provide the means to:

  • Refresh repository metadata. Then, when users run yum, they will not have to wait for metadata to be downloaded, providing a more responsive experience.
  • Check for updates, and alert users that updates are available for their system.
  • Download available updates. Users who wish to apply updates manually will then be able to do so more quickly and conveniently, as they will not have to wait for the updates to be downloaded.
  • Install updates automatically.


Benefit to Fedora

Previously, yum-updatesd and yum-cron were available to automate certain yum tasks. However, these did not provide all the capabilities that users required, and were difficult to use and maintain. In particular, yum-cron simply provided a wrapper to the yum command line interface, making it difficult to access different capabilities and options. This feature will unify and extend yum-updatesd and yum-cron to provide a single, clear, consistent way to automate yum tasks. This will benefit Fedora users and administrators by making it much more simple and convenient to keep their systems up to date.


Scope

This is a relatively isolated change. It should have minimal impact on the rest of the distribution, as it will not perform any functions that could not be done manually with yum.

  • Implement functionality to check, download and install updates
  • Implement methods to emit messages to users about available updates and the operation of the program
  • Submit package for inclusion in Fedora
  • Perform testing and bug fixes

How To Test

  • Configure yum-cron.conf to preform the desired actions
  • Run yum-cron manually, or set it to be run as a cron job.
  • Check that the requested actions are performed to check for, download, or install updates.

User Experience

Users will be able to configure YumCron to perform various functions. Then, the feature will be run as a cron job to perform the requested actions. Users will be notified about the operation of this program according to the method that they select in the configuration file.

Dependencies

No other packages depend on this package.


Contingency Plan

No contingency plan is needed, we can revert to the previous release behavior of yum and yum-updatesd.

Documentation

Release Notes

  • YumCron provides a simple way to automate common yum tasks.

Comments and Discussion