Features/Systemd-unit-cleanup

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
(How To Test)
(Moved back to FeaturePageIncomplete; feature was not approved at 2012-06-18 FESCo meeting, feature owner was given guidance to approach FPC first with guideline changes.)
 
(16 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
== Summary ==
 
== Summary ==
  
Introducing new systemd documentation feature and bringing shipped units closer to upstream with various cleanups.
+
Introducing new systemd documentation feature along with various units cleanups.
  
 
== Owner ==
 
== Owner ==
Line 14: Line 14:
 
* Last updated:  
 
* Last updated:  
 
* Percentage of completion: 20
 
* Percentage of completion: 20
* Progress Tracker [https://bugzilla.redhat.com/show_bug.cgi?id=713562 Bug.]
 
  
 
== Detailed Description ==
 
== Detailed Description ==
  
Introduce 
+
Introducing and including in units new Documentation support that got added to systemd.
  
 +
Fixing PIDFile path to point to the actual runtime directory instead of pointing it to the obsolete /var/run directory which is bind mounted to it and various other minor unit cleanups.
 +
 +
Removal of EnvironmentalFile reference in units which uses /etc/sysconfig/foo file,
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
  
Documentation= Field will bring more informational status output to our users base which links to the relevant man pages for services.
+
Adding the Documentation Field will bring more informational status output to our users base which links to the relevant man pages for the daemon/service.
 +
 
 +
EnvironmentalFiles that reside in /etc/sysconfig directory are Fedora specific which makes those unit not upstream feasible and work against the de-balkanization of the Linux platform.
 +
 
 +
If it's truly necessary for those environment files to be continued to be used which is rather exception than a rule since users/administrator should be using [https://fedoraproject.org/wiki/Systemd#How_do_I_customize_a_unit_file.2F_add_a_custom_unit_file.3F  How_do I customize a unit file ] when altering daemon/service startup, they should be placed in a subdir directly in /etc with the name of the package/subsystem and the environment file reference point to that instead.
  
Removal of EnvironmentalFile entries
 
  
 
== Scope ==
 
== Scope ==
  
 
* Add Documentation= field which will contain relevant man pages to already existing units   
 
* Add Documentation= field which will contain relevant man pages to already existing units   
 +
* Remove various entries in units which are no longer necessary since they are systemd defaults for unit simplification
 
* Change PIDFile=/var/run/foo fields to point to PIDFile=/run/foo instead
 
* Change PIDFile=/var/run/foo fields to point to PIDFile=/run/foo instead
* Drop any EnvironmentalFile= field in units that points to /etc/sysconfig/foo files
+
* Drop any EnvironmentalFile= field in units that points to /etc/sysconfig/foo files
 +
 
 +
 
 +
{{admon/note|Each submitted unit during the F17 did include the above changes with the exception of the ''Documentation'' field that did not exist at that time which should smooth these changes and make the necessary work to complete this much smaller. Each migrated unit during the F18 will of course include the above changes.}}
  
 
== How To Test ==
 
== How To Test ==
Line 48: Line 57:
 
== User Experience ==
 
== User Experience ==
  
Other than the added documentation field in the units status output  
+
Other than the added informative documentation field in the units status output the user should not notice any change.
  
 
== Dependencies ==
 
== Dependencies ==
Line 60: Line 69:
 
== Documentation ==
 
== Documentation ==
  
* It's recommended that documentation for relevant applications that contained and used EnvironmentFile reference points users to [ https://fedoraproject.org/wiki/Systemd#How_do_I_customize_a_unit_file.2F_add_a_custom_unit_file.3F | How_do I customize a unit file ]  
+
* It's recommended that documentation for relevant applications that contained and used EnvironmentFile reference points users to [https://fedoraproject.org/wiki/Systemd#How_do_I_customize_a_unit_file.2F_add_a_custom_unit_file.3F How_do I customize a unit file ] use instead when altering daemon/service startup.
  
 
== Release Notes ==
 
== Release Notes ==
Line 69: Line 78:
 
* See [[Talk:Features/Systemd-unit-cleanup]]  <!-- 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 -->
 
* See [[Talk:Features/Systemd-unit-cleanup]]  <!-- 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:FeatureReadyForWrangler]]-->
+
[[Category:FeaturePageIncomplete]]
 
<!-- When your feature page is completed and ready for review -->
 
<!-- When your feature page is completed and ready for review -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->

Latest revision as of 09:31, 19 June 2012

Contents

[edit] Systemd unit cleanup and enhancement

[edit] Summary

Introducing new systemd documentation feature along with various units cleanups.

[edit] Owner

[edit] Current status

  • Targeted release: Fedora 18
  • Last updated:
  • Percentage of completion: 20

[edit] Detailed Description

Introducing and including in units new Documentation support that got added to systemd.

Fixing PIDFile path to point to the actual runtime directory instead of pointing it to the obsolete /var/run directory which is bind mounted to it and various other minor unit cleanups.

Removal of EnvironmentalFile reference in units which uses /etc/sysconfig/foo file,

[edit] Benefit to Fedora

Adding the Documentation Field will bring more informational status output to our users base which links to the relevant man pages for the daemon/service.

EnvironmentalFiles that reside in /etc/sysconfig directory are Fedora specific which makes those unit not upstream feasible and work against the de-balkanization of the Linux platform.

If it's truly necessary for those environment files to be continued to be used which is rather exception than a rule since users/administrator should be using How_do I customize a unit file when altering daemon/service startup, they should be placed in a subdir directly in /etc with the name of the package/subsystem and the environment file reference point to that instead.


[edit] Scope

  • Add Documentation= field which will contain relevant man pages to already existing units
  • Remove various entries in units which are no longer necessary since they are systemd defaults for unit simplification
  • Change PIDFile=/var/run/foo fields to point to PIDFile=/run/foo instead
  • Drop any EnvironmentalFile= field in units that points to /etc/sysconfig/foo files


Note.png
Each submitted unit during the F17 did include the above changes with the exception of the Documentation field that did not exist at that time which should smooth these changes and make the necessary work to complete this much smaller. Each migrated unit during the F18 will of course include the above changes.

[edit] How To Test

  • Install/update to the package that contains the new native systemd unit file.
    • Check if the update process happened cleanly
    • Check if the service starts cleanly after install
    • check if the service stops cleanly after and install
    • Check if the service reloads cleanly correctly if applicable
    • Check if the service status output contains reference to the relevant man pages
  • Enable the service then restart
    • check if the shutdown process happened cleanly with the service enabled
    • check if the service started cleanly at startup

[edit] User Experience

Other than the added informative documentation field in the units status output the user should not notice any change.

[edit] Dependencies

Depends on legacy sysv initscript to have been converted to native systemd units.

[edit] Contingency Plan

Continue to ship the systemd units as is.

[edit] Documentation

  • It's recommended that documentation for relevant applications that contained and used EnvironmentFile reference points users to How_do I customize a unit file use instead when altering daemon/service startup.

[edit] Release Notes

There shouldn't be anything we need to specifically say other than highlighting the change.

[edit] Comments and Discussion