From Fedora Project Wiki

< Modularity‎ | Getting Started

Revision as of 16:40, 27 June 2016 by Nphilipp (talk | contribs) (→‎Development Method: don't use old langdon-modularity Taiga URL, mention differentiation between normal sprints and roadmap)

Introduction to the Modularization initiative in Fedora

Modularity (formerly, Modularization) is an ongoing initiative in Fedora to resolve the issue of divergent, occasionally conflicting lifecycles of different components. A module provides functionality (for instance a web server) and includes well-integrated and -tested components (for instance Apache httpd and the libraries on which it depends). It can be deployed into production in various ways, for instance as "classic" RPM packages or a container image, and is updated as a whole. Different modules can emphasize new features, stability, security, etc. differently.

Note we are all still getting organized and nothing's set in stone yet.

Steps to get involved

How to contact the Modularization WG team
Mailing list: devel
Visit this link to sign up for the email list for the Modularization WG team.
Chat: #fedora-modularization[?]
This is where real-time chat with Modularization WG team members happens.

To get involved with the Modularity Working Group, please follow the following steps for becoming a part of the team.

  1. Read this wiki page and understand the development methods and technical details.
  2. Get in touch with us on the devel mailing list and our IRC channel, #fedora-modularization.
  3. Attend one of our weekly meetings and introduce yourself.
  4. Become familiar with the Agile project management and create an account on the Fedora Taiga.
  5. Create an account on Pagure and file an issue in the Fedora Modularization group requesting membership.

Get in touch

There's no dedicated mailing list yet and everything regarding this topic should be discussed on the general Fedora Development list. Most of us also hang out on the #fedora-modularization channel on Freenode.

Planning

Formal meetings are held once a week by the Modularity Working Group. See the Fedocal to find out when the group is meeting.

Development Method

We will use agile software development methods for Modularization, more specifically: a hybrid of Scrum and Kanban adapted to the constraints we have in Fedora. For instance, not all contributors can commit to be involved like a regular, full-time employee, meaning that rigid use of 2-week-long Scrum Sprints can be an obstacle to participating for some people.

If you're not familiar with agile development or the methods we use, here are some links to get you started:

Agile development methods often come with their own lingo that can be confusing to the "uninitiated"—like "epic", "sprint" (or "iteration"), "spike". Many of the terms used are explained over at the Agile Dictionary.

We manage the project using Taiga on Fedora Infrastructure, one instance for individual sprint work items and another for higher-level stuff ("epics").

Technical details

Architecture

The current idea we're working with comprises of three main parts, some more complex than others. This can change at any point.

  1. Module sources - not yet defined; these could be RPM repositories, comps files, simple component lists, COPRs, docker images...
  2. A service consuming the module sources and providing digested metadata for the end clients.
  3. The end clients communicating with the service, for example a standalone installation tool, a dnf plugin or a web service providing pretty module overview.

Code repositories

We currently host all of our code at Pagure—the metadata service, its client, metadata drafts and even a couple of proof-of-concept modules. Repositories typically start with the fm- prefix and are open to all members of the Pagure modularization group.

Documentation

This differs for every project.

Documentation for the client is hosted at ReadTheDocs.org and is being automatically rebuilt every 15 minutes. This will be handled by Pagure commit hooks once that feature is implemented and deployed.

Metadata service

The metadata service was deployed on a test server and populated with testing data. The client is configured to use this instance at this point.