summaryrefslogtreecommitdiff
path: root/devel/vision/1_requirements.xml
blob: 6f379ac0884000c9677b722c64dc6cd76d975b24 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<?xml version="1.0" encoding="utf-8"?>
<chapter label="1" id="requirements">
    <title>Organisational Requirements</title>
    <section id="background">
        <title>Background</title>
        <para>The Adélie Linux distribution has a belief that "all people, in all walks of life, deserve the very best that their technology can offer them".<footnote><para><citetitle>Adélie Linux home page</citetitle>, 2019-08-23, <ulink url="https://www.adelielinux.org/">adelielinux.org</ulink>.</para></footnote>
            However, at present, the only way to install the Adélie Linux distribution is via a list of complex commands, entered at a shell prompt that may be foreign or confusing to many people.<footnote><para><citetitle>HOWTO: Manually install Adélie Linux</citetitle>, 2019-01-12, <ulink url="https://wiki.adelielinux.org/wiki/HOWTO:Manually_install_Ad%C3%A9lie_Linux">Adélie Wiki</ulink>.</para></footnote>
            Further, improper execution of these commands can cause permanent loss of data<footnote><para>Such as improper use of <command>parted</command>, or even <command>mkfs</command>.</para></footnote>, or even hardware damage<footnote><para>Such as <ulink url="https://github.com/rhboot/efivar#warning">lovely UEFI implementations</ulink>.</para></footnote>.</para>
        <para>To this end, a new system must be created.  The system must allow any user to install Adélie Linux onto their computer without needing to use a command line.</para>
        <para>Additionally, we have identified a significant user need for installation automation.</para>
    </section>
    <section id="opportunity">
        <title>Opportunity</title>
        <para>Existing installation systems in the current Linux distribution landscape do not adequately meet the needs of different Linux users.  In this section, we will review current installation systems and their deficiencies.  Current distributions contain one of three major types of installation systems or routines: those that hold the user's hands at the expense of flexibility (or "batteries included"); those that are rigid and don't work well outside of a limited scope (or "fixed"); and those that require the user to do most or all of the installation themselves using a command line (or "manual").</para>
        <section id="existing">
            <title>Existing Systems</title>
            <section id="batteries">
                <title>Batteries included</title>
                <para>The Ubuntu distribution uses an installer named Ubiquity.
                    Ubiquity is very user friendly; however, it has many shortcomings.
                    It cannot be scripted - administrators must use the Debian installer with a preseed file to script an Ubuntu installation.
                    The partitioning options offered are limited.
                    It uses DBus and udevadm to set up networking, which is not robust.
                    It is focused on x86 and unlikely to work well on other architectures.
                    It uses Debian's partman internally for partitioning, which is a mess on its own.</para>
                <para>The Debian distribution uses debian-installer, or d-i.  d-i offers a lot of flexibility with plug-in installation steps.
                    However, it suffers from many limitations.
                    The scripting format, termed "preseed", is extremely convoluted and very poorly documented.
                    It has been described as a "nightmare" by its own users<footnote><para>See <ulink url="https://lists.debian.org/debian-boot/2012/01/msg00016.html">Eromenko 2012</ulink>, for example.</para></footnote> and has many warts as a result of being partially written in Perl, and partially in C, which resulted in a maintenance burden.
                    In addition, d-i does not always support common hardware, especially on the remastered CDs required for scripting - notably, SATA drivers are not added which renders it unusable on most modern computers.
                    It suffers from a severe lack of predictable results; given the same input, it does not always produce the same output.
                    This is due to various race conditions throughout the system.</para>
                <para>The Red Hat and Fedora family of distributions use the Anaconda installer.
                    This is one of the oldest systems still in use today, and is wholly written in Python.
                    Scripting support via Kickstart files is higher quality than Debian's installer, but still suffers from multiple issues.
                    Repository signatures cannot be added.  If packages are required that are not present in the base RHEL/Fedora repo, you must allow unsigned packages to be installed.  This can present a security risk in the case of DNS or ARP poisoning.
                    Further, until the most recent version of Fedora, the only supported wireless network authentication mechanism was WEP, which is highly insecure and is typically not available on newer wireless networks.
                    The newest version additionally supports WPA passphrases; it does not support RADIUS authentication or certificate-based authentication.</para>
                <para>The Calamares system is considered most likely to be a "batteries included" system, but we did not investigate it thoroughly during our requirements elicitation phase due to time constraints.</para>
            </section>
            <section id="fixed">
                <title>Fixed</title>
                <para>The Alpine Linux installer is a set of interactive shell scripts that offers very few options.
                    A user can choose between using a hard disk for the entire system or for data only, leaving the OS and software in a tmpfs.
                    There is no option to use an existing partition map, or to use an alternative to LVM2, nor to use RAID.
                    Because it is a set of interactive shell scripts, it does not make sense to script an installation using it.
                    Typically, users script a manual installation (such as in the "Manual" section below).
                    There is no set of default packages: the installation system only installs a minimal base system.
                    There is no support for using IPv6 in the Alpine Linux installer, and IPv6 support is crucial for usage on the modern Internet.</para>
                <para>FreeBSD and OpenBSD also fall in this category.
                    OpenBSD's installation system is very close to Alpine's, while the FreeBSD bsdinstall makes many assumptions about the user's desired choices and offers very little customisation.
                    One area where bsdinstall succeeds is the partition interface.
                    None of the three major BSD derivatives support any form of scripted install.</para>
            </section>
            <section id="manual">
                <title>Manual</title>
                <para>The Arch Linux distribution provides a list of commands for the user to run, and provides a very minimal environment on their boot CD to allow them to run.
                    You must manually bootstrap the package manager, Pacman, and install the base system packages yourself.
                    This lends itself to scripting, but it again must be entirely manual.
                    The user would be scripting the disk manipulation, clock set up, package database initialisation, and so on, themselves.</para>
                <para>The Gentoo distribution provides a "stage" tarball containing a base system.
                    The user must create partitions manually before extracting the stage to the target.
                    The user must also build and install their own kernel and bootloader.
                    As with Arch Linux, any scripting would be automating the low-level commands themselves; there is no provided framework for automating installs in Gentoo.</para>
            </section>
        </section>
        <section id="point">
            <title>Where Our Solution Fits</title>
            <para>We feel that there is a significant user need for an installation system that is as easy to use as any of the proprietary operating systems, such as Windows 7 or Mac OS X.
                Such a system would significantly further our goal of bringing high-quality, Libre software to all people of all walks of life.
                Additionally, such a system could gain Adélie Linux significant market-share, leading to more sponsors, which will lead to further growth and the ability to take on even more ambitious projects in the future.</para>
        </section>
    </section>
    <section id="objectives">
        <title>Objectives and Success Criteria</title>
        <para>We have identified a few key objectives that we feel are important for the system to meet.</para>
        <para>For the purpose of these objectives, "completing" the installation routine means that the user has finished answering the system and that the system may now begin performing the installation.</para>
        <orderedlist id="OBJ">
            <listitem id="OBJ-1"><para>Users who have not used the Adélie Linux system before, but have prior experience with other Linux systems, shall be able to complete the installation routine in less than 15 minutes.</para></listitem>
            <listitem id="OBJ-2"><para>Users who have not used any Linux system before shall be able to complete the installation routine in less than one hour.</para></listitem>
            <listitem id="OBJ-3"><para>Positive reviews of our installation system in at least two publications within six months.</para></listitem>
            <listitem id="OBJ-4"><para>Rated as the best installation system in at least one publication within one year.</para></listitem>
        </orderedlist>
    </section>
    <section id="classes">
        <title>User Classes and Needs</title>
        <para>We have identified four major classes of users, each with their own unique set of needs and requirements for Project Horizon.
            For each class of user, we have an example profile of a person who would belong to that class of user.
            We then list their reasons for using the system and the features that matter most to them.</para>
        <section id="beginner">
            <title>Charlie: The Beginner</title>
            <para>Charlie is a 45 year old designer who has never used Linux before.  Charlie is concerned about privacy using Windows 10, and would like to install an alternative operating system.  Charlie does not want to erase the current OS installed on this computer.</para>
            <section>
                <title>Needs</title>
                <orderedlist id="NEB">
                    <listitem id="NEB-1"><para>Simple user interface with defaults pre-set for most common identifiable use cases.</para></listitem>
                    <listitem id="NEB-2"><para>Ability to install "side-by-side" with another OS with minimal effort, including:
                        <orderedlist>
                            <listitem><para>resizing the current OS partition;</para></listitem>
                            <listitem><para>creating needed new partition(s) for Adélie Linux; and</para></listitem>
                            <listitem><para>ensuring a boot menu is displayed that allows choice on whether to boot Adélie Linux or another OS.</para></listitem>
                        </orderedlist></para>
                    </listitem>
                    <listitem id="NEB-3"><para>On-screen help for explaining terms used and an explanation for available options.</para></listitem>
                    <listitem id="NEB-4"><para>Disk encryption to keep data private and secure at-rest.</para></listitem>
                </orderedlist>
            </section>
        </section>
        <section id="hacker">
            <title>Dakota: The Enthusiast</title>
            <para>Dakota is a 27 year old Linux enthusiast, who has used Linux for 4 years.  Dakota has used other distributions and wants to try Adélie Linux on a laptop, and has opinions on package choices.</para>
            <section>
                <title>Needs</title>
                <orderedlist id="NEE">
                    <listitem id="NEE-1"><para>Customisation of partitioning, including sizes, file systems, and mountpoints.</para></listitem>
                    <listitem id="NEE-2"><para>Ability to choose init system, shell, and window manager.</para></listitem>
                </orderedlist>
            </section>
        </section>
        <section id="admin">
            <title>Jamie: The Administrator</title>
            <para>Jamie is a 33 year old systems administrator at a business.  Jamie wants to deploy Adélie Linux to five Web servers on a business network.</para>
            <section>
                <title>Needs</title>
                <orderedlist id="NEA">
                    <listitem id="NEA-1"><para>Network-based, scripted installation.</para></listitem>
                    <listitem id="NEA-2"><para>Ability to select additional packages to install.</para></listitem>
                    <listitem id="NEA-3"><para>Assurance of security and integrity, for both the installation script and the packages installed.</para></listitem>
                </orderedlist>
            </section>
        </section>
        <section id="dev">
            <title>River: The Developer</title>
            <para>River is a 20 year old tinkerer.  River has Single Board Computers (SBCs) such as a Pine64 and a Quark.  River also has multiple disparate laptops.</para>
            <section>
                <title>Needs</title>
                <orderedlist id="NED">
                    <listitem id="NED-1"><para>Ability to choose init system, shell, and window manager.  (See NEE-2.)</para></listitem>
                    <listitem id="NED-2"><para>Support for esoteric hardware.</para></listitem>
                    <listitem id="NED-3"><para>Disk encryption to keep data private and secure at-rest.  (See NEB-4.)</para></listitem>
                    <listitem id="NED-4"><para>Customisation of partitioning, including sizes and mountpoints.  (See NEE-1.)</para></listitem>
                    <listitem id="NED-5"><para>Ability to select additional packages to install.</para></listitem>
                </orderedlist>
            </section>
        </section>
    </section>
    <section id="risks">
        <title>Risks</title>
        <para>We have identified the following risks associated with developing Project Horizon.</para>
        <orderedlist id="DRI">
            <listitem id="DRI-1"><para>User acceptance may be lower than anticipated, causing less adoption than desired for Adélie Linux.</para>
                <para>Impact: High; Probability: Medium.</para>
                <para>Potential mitigations: Ensure that user acceptance tests are done throughout the development cycle.  Involve designers that have experience with user experience best practices.  For higher quality feedback, involve parties from different communities whom have different levels of familiarity with Linux.</para></listitem>
            <listitem id="DRI-2"><para>Scheduling over-runs could cause severe financial losses.</para>
                <para>Impact: High; Probability: High.</para>
                <para>Potential mitigations: Raise funding for Adélie Linux from sources that are not contigent on the release of Project Horizon first.  Drop lower priority features that are slated for 1.0 if schedule slippage begins.  Seek more contributors.</para></listitem>
            <listitem id="DRI-3"><para>Packages and security updates could fall behind if the team puts all resources into Project Horizon.</para>
                <para>Impact: Medium; Probability: Low.</para>
                <para>Potential mitigations: Not every Adélie Linux committer will be dedicated to Project Horizon.  Some committers can do important security bumps while the others work on Project Horizon.</para></listitem>
        </orderedlist>
        <para>We have identified the following risks associated with <emphasis>not</emphasis> developing Project Horizon.</para>
        <orderedlist id="NRI">
            <listitem id="NRI-1"><para>Users will not want to install Adélie Linux because manual installation is too complex.</para>
                <para>Impact: High; Probability: High.</para></listitem>
            <listitem id="NRI-2"><para>Sponsors will not fund Adélie Linux because they cannot easily install it.</para>
                <para>Impact: High; Probability: High.</para></listitem>
            <listitem id="NRI-3"><para>Users having technical problems due to bad installation procedures would give Adélie a poor reputation and take up a lot of time for community support.</para>
                <para>Impact: High; Probability: High.</para></listitem>
            <listitem id="NRI-4"><para>Potential developers and maintainers would not contribute to Adélie Linux because the barrier to getting started with Adélie is too high.</para>
                <para>Impact: High; Probability: Medium.</para></listitem>
        </orderedlist>
    </section>
</chapter>