| Line 109: | Line 109: | ||
== Documentation == | == Documentation == | ||
The API itself will need to be documented for developers of tools depending on it. This cannot be done until it is designed. | |||
<!-- 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. --> | ||
<!-- REQUIRED FOR SYSTEM WIDE CHANGES --> | <!-- REQUIRED FOR SYSTEM WIDE CHANGES --> | ||
== Release Notes == | == Release Notes == | ||
Revision as of 19:05, 1 April 2014
Framework for Server Role Deployment
Summary
A new D-Bus service, and associated command-line tools, to deploy and manage Server Roles.
Owner
- Name: Fedora Server Working Group
- Email: server AT lists DOT fedoraproject DOT org
- Release notes owner:
- Product: Server
- Responsible WG: Server
Current status
- Targeted release: Fedora 21
- Last updated: April 1, 2014
- Tracker bug: <will be assigned by the Wrangler>
Detailed Description
A new D-Bus service will be made available, exposing available server roles, making it possible to deploy, configure and manage them.
Benefit to Fedora
A common framework will allow multiple tools to deploy and configure roles at various times, without conflict. We expect this framework will be used by the installer and also by end-user tools including a command-line tool and probably higher-level tools like Cockpit.
Scope
- Proposal owners: Write, document, package and test the D-Bus API.
- 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)
Upgrade/compatibility impact
This is new functionality, so we envisage no impact on upgrades from previous releases.
The newly introduced user-facing API is intended to be long-term, available also in future releases of Fedora without breaking applications that use it as documented. (Note that the same promise is not given for the API used to implement the server roles.)
How To Test
The API should be relatively easily testable in a VM without special hardware or configuration. Test procedure would be more or less to do a basic/minimal install, install the relevant package, and then test that roles can be deployed and configured via direct D-Bus message injection (using dbus-send, dbus-monitor etc).
Indirect testing of the API will also likely become part of Server validation testing, as role deployment and configuration are likely to figure prominently in that testing, and will run through the API.
User Experience
This Change will not be directly visible in typical server admin tasks.
Dependencies
This Change does not really depend on anything else. In itself, though, it is more or less the foundation of the Server product: without this, it would be quite difficult to complete the rest of the Server product design as envisaged. The user-facing tools for Role management will depend on this package, and so will other tools which do Role management, likely including the installer.
Contingency Plan
- Contingency mechanism: Do not ship the Server product with Fedora 21.
- Contingency deadline: Alpha
- Blocks release? No
- Blocks product? Server
Documentation
The API itself will need to be documented for developers of tools depending on it. This cannot be done until it is designed.