From Fedora Project Wiki
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!-- Self Contained or System Wide Change Proposal?
= Replace UDisks2 by Storaged =
Use this guide to determine to which category your proposed change belongs to.
 
Self Contained Changes are:
* changes to isolated/leaf package without the impact on other packages/rest of the distribution
* limited scope changes without the impact on other packages/rest of the distribution
* coordinated effort within SIG with limited impact outside SIG functional area, accepted by the SIG
 
System Wide Changes are:
* changes that does not fit Self Contained Changes category touching
* changes that require coordination within the distribution (for example mass rebuilds, release engineering or other teams effort etc.)
* changing system defaults
 
For Self Contained Changes, sections marked as "REQUIRED FOR SYSTEM WIDE CHANGES" are OPTIONAL but FESCo/Wrangler can request more details (especially in case the change proposal category is
improper or updated to System Wide category). For System Wide Changes all fields on this form are required for FESCo acceptance (when applies). 
 
We request that you maintain the same order of sections so that all of the change proposal pages are uniform.
-->
 
<!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name.  This keeps all change proposals in the same namespace -->
 
<!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name.  This keeps all change proposals in the same namespace -->
= Storaged drop-in replacement for UDisks2 =


== Summary ==
== Summary ==
<!-- A sentence or two summarizing what this change is and what it will do. This information is used for the overall changeset summary page for each release. -->
[http://storaged.org/ Storaged] extends [https://www.freedesktop.org/wiki/Software/udisks/ UDisks2] API by exporting several enterprise features (in form of plugins), such as LVM2 and iSCSI. This project is a drop-in replacement for UDisks2, either from D-Bus or binary point of view. The main motivation of this change is to provide the unified D-Bus API for all the clients who are willing to manage LVM2, iSCSI, Btrfs, BCache, LSM and ZRam.
Storaged extends UDisks2 API by exporting several enterprise features (by plugins), such as LVM2 and iSCSI. This project is a drop-in replacement for UDisks2, either from D-Bus or binary point of view. The main motivation of this change is to provide the unified D-Bus API for all the clients who are willing to manage LVM2, iSCSI, Btrfs, BCache, LSM and ZRam.


== Owner ==
== Owner ==
Line 32: Line 9:
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: [[User:phatina| Peter Hatina]]
* Name: [[User:phatina | Peter Hatina]], [[User:tsmetana | Tomáš Smetana]]
* Email: phatina redhat com
* Email: phatina redhat com, tsmetana redhat com
* Release notes owner:
* Release notes owner: [[User:Immanetize|Pete Travis]] ([[User talk:Immanetize|talk]])
<!--- 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 31:
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=1330055 #1330055]


== Detailed Description ==
== 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. -->
Aim of Storaged is to provide unified higher level management interface for various clients who are willing to query and manage storage bits of the system. We plan to replace UDisks2 by Storaged, since the Storaged itself is the fork of UDisks2 and these 2 projects in its core haven't diverged so much (Storaged got some improvements which popped up while using it).
Aim of Storaged is to provide unified higher level management interface for various clients who are willing to query and manage storage bits of the system. We plan to replace UDisks2 by Storaged, since the Storaged itself is the fork of UDisks2 and these 2 projects in its core haven't diverged so much (Storaged got some improvements which popped up while using it).


== Benefit to Fedora ==
== Benefit to Fedora ==
The drop-in replacement is beneficial for Fedora because currently, there are 2 similar projects (one derived from the other). Since, Storaged can export the same API as UDisks2 does, but with several enterprise extensions, it is natural to replace one daemon with the extended one.
The drop-in replacement is beneficial for Fedora because currently, there are 2 similar projects (one derived from the other). Since, Storaged can export the same API as UDisks2 does, but with several enterprise extensions, it is natural to replace one daemon with the extended one:
 
* we do not need to have very similar services running at the same time;
* one provides only a subset of operations when compared to the other service
<!-- 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 87: Line 63:
== Upgrade/compatibility impact ==
== Upgrade/compatibility impact ==
<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->
<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
Since, Storaged should replace UDisks2 in 1:1 manner, there is no additional change required.
Since, Storaged should replace UDisks2 in 1:1 manner, there is no additional change required.


== How To Test ==
== How To Test ==
<!-- This does not need to be a full-fledged document. Describe the dimensions of tests that this change implementation 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.
Remember that you are writing this how to for interested testers to use to check out your change implementation - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your change.
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 change? What packages
need to be installed, config files edited, etc.?
2. What specific actions do I perform to check that the change is
working like it's supposed to?
3. What are the expected results of those actions?
-->
Install Storaged which replaces UDisks2 and verify that:
Install Storaged which replaces UDisks2 and verify that:
* GNOME Disks works properly
* GNOME Disks works properly
* GVFS works as expected (notifications of new devices, mouting, ...)
* GVFS works as expected (notifications of new devices, mouting, ...)
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
N/A (not a System Wide Change)


== User Experience ==
== User Experience ==
User will not notice any change by the switch UDisks2 -> Storaged.
User will '''not notice''' any changes comming from the switch UDisks2 to Storaged.


== Dependencies ==
== Dependencies ==
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this change depends?  In other words, completion of another change 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 change)? -->
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this change depends?  In other words, completion of another change 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 change)? -->
The main consumer of Storaged is Cockpit; Blivet and Red Hat Unified Storage Console. We have an agreement with the developers of the respective projects that we will sync when the Storaged replaces UDisks2.
The main consumer of Storaged is [http://cockpit-project.org/ Cockpit] and [https://github.com/rhinstaller/blivet Blivet]. We have an agreement with the developers of the respective projects that we will sync when the Storaged replaces UDisks2.


== 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 "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
* Contingency mechanism: (What to do?  Who will do it?)
* Contingency mechanism:
** If we can not make the switch in time (merge in Storaged upstream, Cockpit and Blivet D-Bus API switch), UDisks2 '''will not be replaced'''.
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
* Contingency deadline: N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- * Contingency deadline: N/A (not a System Wide Change) --> <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
* Blocks release? N/A (not a System Wide Change), Yes/No <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- * Blocks release? N/A (not a System Wide Change), Yes/No --> <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Blocks product? product <!-- Applicable for Changes that blocks specific product release/Fedora.next -->
<!-- * Blocks product? product --> <!-- Applicable for Changes that blocks specific product release/Fedora.next -->


== Documentation ==
== Documentation ==
<!-- Is there upstream documentation on this change, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
<!-- Is there upstream documentation on this change, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
 
Documentation for Storaged can be found at [http://storaged.org/ Storaged Documentation]
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
N/A (not a System Wide Change)  
<!-- N/A (not a System Wide Change) -->


== Release Notes ==
== Release Notes ==
Line 143: Line 101:
Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.  
Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.  
-->
-->
 
https://fedoraproject.org/wiki/Documentation_System_Daemons_Beat
[[Category:ChangePageIncomplete]]
[[Category:ChangeAcceptedF25]]
<!-- 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 -->
Line 151: Line 109:


<!-- Select proper category, default is Self Contained Change -->
<!-- Select proper category, default is Self Contained Change -->
[[Category:SelfContainedChange]]
<!-- [[Category:SelfContainedChange]] -->
<!-- [[Category:SystemWideChange]] -->
[[Category:SystemWideChange]]

Latest revision as of 17:52, 11 September 2016

Replace UDisks2 by Storaged

Summary

Storaged extends UDisks2 API by exporting several enterprise features (in form of plugins), such as LVM2 and iSCSI. This project is a drop-in replacement for UDisks2, either from D-Bus or binary point of view. The main motivation of this change is to provide the unified D-Bus API for all the clients who are willing to manage LVM2, iSCSI, Btrfs, BCache, LSM and ZRam.

Owner

Current status

Detailed Description

Aim of Storaged is to provide unified higher level management interface for various clients who are willing to query and manage storage bits of the system. We plan to replace UDisks2 by Storaged, since the Storaged itself is the fork of UDisks2 and these 2 projects in its core haven't diverged so much (Storaged got some improvements which popped up while using it).

Benefit to Fedora

The drop-in replacement is beneficial for Fedora because currently, there are 2 similar projects (one derived from the other). Since, Storaged can export the same API as UDisks2 does, but with several enterprise extensions, it is natural to replace one daemon with the extended one:

  • we do not need to have very similar services running at the same time;
  • one provides only a subset of operations when compared to the other service

Scope

  • Proposal owners:
  • 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

Since, Storaged should replace UDisks2 in 1:1 manner, there is no additional change required.

How To Test

Install Storaged which replaces UDisks2 and verify that:

  • GNOME Disks works properly
  • GVFS works as expected (notifications of new devices, mouting, ...)

User Experience

User will not notice any changes comming from the switch UDisks2 to Storaged.

Dependencies

The main consumer of Storaged is Cockpit and Blivet. We have an agreement with the developers of the respective projects that we will sync when the Storaged replaces UDisks2.

Contingency Plan

  • Contingency mechanism:
    • If we can not make the switch in time (merge in Storaged upstream, Cockpit and Blivet D-Bus API switch), UDisks2 will not be replaced.

Documentation

Documentation for Storaged can be found at Storaged Documentation

Release Notes

https://fedoraproject.org/wiki/Documentation_System_Daemons_Beat