Skip to content

Commit 02ba4e9

Browse files
mckaygerhardmckaygerhard
committed
users and group docs improved with missing information fixed
* it addressed and close #131 * improves the very vage requirements documentation * OMV is the most flexible NAS system pointed that * separate software requirements and hardware requirements * software requirementes are handled by OS and depends but pointed some packages that are important for * pointed that the OS Debian is the main software requisite * Page must be titled as "requirementes" cos hardware are prerequisited but those depends on software main one: the Debian OS, if such hardware is not supported so OMV could not be installed or worked in good way.. so prerequisites as list are very confused about it * set that minimal requirements are fit and able to manage: * a root fs partiton of 1.5G was enough using netinstall iso, and deactivating recommends, after that setup no automatic updates and create cron task to clean apt package cache. this dont allow upgrades but allows updates. * a swap of 100M was enough i setup linux to do not use swap in any case.. but novice user wil not have skilss so .. * of course those are for skilled users.. so write sections of recommendations for novice users * setup a NAS system is easy with OMV but a minimal of knowledge is required for non experienced users, so write such need in each section. **Warning** i put that 1 disk is enought as storage drives, that is basically officially true adn supported, if you as skilled adminstrator just install OMV over fresh debian setup! this could be by leaving a free partition already formated!
1 parent d1f68bf commit 02ba4e9

File tree

1 file changed

+235
-20
lines changed

1 file changed

+235
-20
lines changed

‎prerequisites.rst

+235-20
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,250 @@
1-
Prerequisites
1+
Requisites
22
=============
33

4-
Before installing |omv| make sure your hardware is supported.
4+
The |omv| system is the most flexible Network Attached Storage (NAS) on the market,
5+
this is because it relies on the operating system Debian GNU/Linux [9]_
56

6-
* **CPU**: Any x86-64 or ARM compatible processor
7-
* **RAM**: 1 GiB capacity
8-
* **HDD**:
7+
Any system has software requirements and hardware requirements, also minimal
8+
ones and recommended ones..
99

10-
* **System Drive**: min. 4 GiB capacity (plus the capacity of the RAM)
11-
* **Data Drive**: capacity according to your needs
10+
Hardware requirements
11+
---------------------
1212

13-
.. note::
14-
The whole disc will be occupied by the system and swap space [1]_, so size
15-
doesn't matter so much. Data storage on the system disc is not supported.
13+
====== ================ ========= ========== ==================================
14+
Item supported Minimal Best Recommendation
15+
====== ================ ========= ========== ==================================
16+
DRIV SSD/HDD/USB... 1 disk 2 disk 2 disks: 128Gib HDD + 500Gib SSD
17+
RAM 1Gib+ any 1Gib 4Gig 8Gib+ dual channel DDR4/DDR3
18+
NIC WiFi/Ether/USB any 10Mb NIC 1GiB NIC or 10Gb NICs: SFP fiber
19+
CPU arm,x86,x64 32bit 64bit Intel Dual Core, AMD Ryzen
20+
====== ================ ========= ========== ==================================
1621

17-
.. note::
18-
Take into account in your considerations about the size of the system disk
19-
that various plugins such as `openmediavault-podman` or `openmediavault-k8s`
20-
store their data (e.g. container images) on the system disk.
22+
The storage drives (DRIV)
23+
^^^^^^^^^^^^^^^^^^^^^^^^^
2124

22-
Spinning Harddisk, SSD [2]_, Disk-on-Module [3]_, CompactFlash [4]_ or USB thumb
23-
drive [5]_ type drives can be used as system drive.
25+
This is the key of the system. |omv| supports any drive hardware and any drive
26+
interface (SATA, ISE, SCSI, USB, SERIAL) but information and management will
27+
depend on the disk drives supported by the Debian operating system.
28+
29+
Modern hard disks drives have firmware inside that reports several attributes,
30+
Any hard disks drives is supported but |omv| only supports SMART for those
31+
disks that are connected to an HBA in pass-through mode.
32+
33+
The system manages two types of storage unit classification:
34+
35+
System drive storage
36+
The Storage Disk Drive(s) used to put the system program files (by partitions),
37+
**this system drive (that is in fact a couple or more partitions)
38+
cannot officially be used for shared resources or as data drive**.
39+
What supported brands and sizes are covered in the software requirements section below.
40+
The recommendation for the System drive(s) hardware could be older spinning
41+
Hard Disk Drives (HDD), Disk-on-Module [3]_, CompactFlash [4]_ or thumb drives (USB),
42+
the Solid State Disks (SDD [2]_) must be managed.
43+
44+
Data drive storage
45+
The storage disk drive(s) where the data for the defined or used shares resources
46+
wil be stored. **Cannot be the same of the system drive(s) and sizes will
47+
depends of the usage of the resources**. Shared resources are managed over
48+
partitions, which is discussed in the software requirements topic below.
49+
The recommendation for the Data drives must be Solid State Disks (SSD [2]_ disks)
50+
for best performance or spinning Hard Disk Drives (HDD).
51+
52+
The memory (RAM)
53+
^^^^^^^^^^^^^^^^
54+
55+
Enough RAM is vital to maintaining peak performance. There are several combinations
56+
of installation sizes but the **recommendation is at least 4Gib for novice administrators**.
57+
58+
For best practice you should have 8GiB of RAM for basic operations in default installation.
59+
and no matter the size, RAM must be configured in Dual Channel mode [8]_
60+
inclusivelly if there are little amount of, it will improve performance.
61+
62+
Unless other NAS systems the |omv| system can run in at least 1Gib of RAM, but
63+
of course will need expertise.
64+
65+
The communication card (NIC)
66+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67+
68+
A NAS system as means is a network oriented system, of course |omv| is the
69+
most flexible NAS system in the world and allows multiple ways of communication,
70+
this is becouse |omv| offers several modes of shared resources like RSYNC that
71+
do not depends on networking. But there are few key points:
72+
73+
- The NAS write speed to storage is limited to the speed of your NAS computer NIC card
74+
- The NAS write speed to storage is limited to the speed of your network
75+
- Speed of writing to the storage depends on ratio of the number of users accessing it.
76+
77+
Full-duplex NICs are recommended, half-duplex NICs typically offer 10/100 Mbit/s
78+
and storage drives far exceed those speeds but are of course supported by |omv|.
79+
80+
Any supported NIC vendor is determined by the support of the operating system
81+
where |omv| system resides and runs, which is Debian GNU/Linux.
82+
83+
The architecture (CPU)
84+
^^^^^^^^^^^^^^^^^^^^^^
85+
86+
We have already denoted in the requirements table the supported architectures or
87+
processors (which reduces and determines which computers can be used) but this is
88+
really a reference since it is determined by the support of the operating system
89+
where |omv| system resides and runs, which is Debian GNU/Linux.
90+
91+
Any computer system supported by the common requirements of Debian operating
92+
system could be an |omv| system installation target. **Currently we supports
93+
amd64 (x66 64bits), i386 (x86 32bits), ARMv7+ARMv8 (arm64/armel/armhf)**.
94+
95+
Software requirements
96+
---------------------
97+
98+
====== ================= ============== ============== =======================================
99+
Item Software Minimal Best Recommendation
100+
====== ================= ============== ============== =======================================
101+
OS Debian Linux oldoldstable stable Current stable (plus 1 month released)
102+
BOOT BIOS,UBOOT,UEFI BIOS,mbr BIOS,gpt Disable Secure boot, gpt table
103+
SDS HDD,SSD,USB... 2 partitions 3 partitions Root with 120G size, 8G swap size
104+
DDS HDD,SSD,USB... 1 partition 1 per share One disk or part per shared resource
105+
NET LAN,WAN,SAN,VPN LAN SAN,PAN,LAN Fiber ipv4, or at least cable LAN
106+
====== ================= ============== ============== =======================================
107+
108+
The operating system (OS)
109+
^^^^^^^^^^^^^^^^^^^^^^^^^
110+
111+
The |omv| is a piece of software, it resides and runs under a key software OS
112+
named Debian GNU/Linux as "the universal operating system" [9]_
113+
114+
Supported Debian OS versions can be checked in the :doc:`releases section </releases>`
115+
116+
While possible to deploy in a virtual environment, depending of the nature of
117+
virtualization it will degrade the performance access in various ways. Installation
118+
in LXC or any other container based solution is not supported.
119+
120+
Whatever the situation, the |omv| assumes that target operating system does not
121+
have any previous installation of any of the programs used by |omv| dependencies:
122+
123+
============= ============== ================= ==========================================
124+
software package related to Observations
125+
============= ============== ================= ==========================================
126+
http server nginx |webui| port 80 must be free at installation
127+
http system php |webui| only OS php packages wil be used!
128+
display GUI lighdm,xdm.. Desktop install **Conflicts, any will be deinstalled**
129+
network man netplan.io Networking network is managed by |omv| with netplan
130+
ssh server ssh Remote access any configuration will be managed
131+
mbs server samba Shared drives any configuration will be managed
132+
quota man quota Quota manage any configuration will be managed
133+
============= ============== ================= ==========================================
134+
135+
The device boot (BOOT)
136+
^^^^^^^^^^^^^^^^^^^^^^^^^
137+
138+
|omv| will install on any kind of boot device and this will relies on the
139+
operating system that is Debian. The downloable ISO image ready to use from
140+
the oficial web page only supports at the moment amd64 with BIOS mode boot.
141+
142+
The System drive storage (SDS)
143+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
144+
145+
The system storage disk will be fully managed and taken over by the |omv| after
146+
installed. Any brand is supported as is also supported by the Debian system.
147+
For Flash Drive type storage devices as well as solid state drives being used as
148+
system storage drives please refer to the last section for technical details.
149+
150+
In case of the official ISO instalation, will automatically partition the system
151+
storage disk drive into 3 partitons. Consult the next table for.
152+
153+
In case of a manual installation on a previous Debian operating system, this
154+
**drive must have at least two partitions**. Consult the next table for.
155+
156+
============ ========== =========== =======================================
157+
Partition Min size Best size Mandatory
158+
============ ========== =========== =======================================
159+
``/boot`` 256Mib 500Mib Optional, partition used to boot
160+
``/`` 4Gi 120Gib Yes, the partition were system install
161+
``swap`` 100Mib 16Gib Yes, the partition for virtual ram
162+
============ ========== =========== =======================================
163+
164+
The Data drive storage (DDS)
165+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
166+
167+
The data storage disk will be partially managed by the |omv| after installed,
168+
and only in customized installation can be a partiton of the same system drive
169+
storage.
170+
171+
Each data storage drive will be managed, but regardless of the partitioning
172+
scheme, all data drive partitions will be mounted at the ``/srv/`` path.
173+
The **data storage drive must be a different disk drive than the system disk drive**
174+
where the operating system is installed. **One partition of each data
175+
drive can handle one or many shared resources.**
176+
177+
============== ========== =========== ========================================
178+
Partition Min size Best size Mandatory
179+
============== ========== =========== ========================================
180+
``/srv/<*>`` 100Mib bigger Yes, size as need! example 128Gib
181+
============== ========== =========== ========================================
182+
183+
Technical notes
184+
---------------
185+
186+
Take into **consideration that as more exquisite the customization as less supported
187+
could be.**.
188+
189+
|omv| allows for minimal deployment and use of the system with very minimal
190+
hardware/software requirements, at the cost of the key knowledge, but other NAS
191+
systems allow ease of use at the cost of high requirements. |omv| allows both as
192+
well in a well balanced use cases! [7]_
193+
194+
About minimal or custom setups
195+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
196+
197+
It can be noted that |omv| system can be installed on just 4Gib of system partition,
198+
with no more than 1Gib of RAM and using a WiFi or USB connection to access it
199+
remotely (cos is a NAS system of course), on any small device such as Raspberry
200+
ones which are ARM, or old i386s machines no matter is those are 32 or 64 bits,
201+
but of course as more exquisite the configuration more knowledge will be need
202+
as per `issue comment #131 <https://github.com/openmediavault/openmediavault-docs/issues/131#issuecomment-2546765841>`_.
203+
204+
Technically OMV can be installed on a single storage disk, this is possible if
205+
it is done on a previously configured Debian system, with a free partition apart
206+
from the 3 necessary system partitions, previously formatted and configured.
207+
Of course this is only possible for skilled linux users.
208+
209+
Drive Storage technical details
210+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
211+
212+
System Drives are not managed as same of Data Drives. System drives are not so
213+
intensively used, but Data Drives will need triks to extend the useful life.
214+
215+
If you use a Flash Drive, select one with static wear leveling 6, without this
216+
the drive will have a very short lifetime. It is also recommended to install and
217+
activate the Flash Memory plugin.
218+
219+
In the same Solid State Disk, or rather Drive (SSD) for x86 architectures, is
220+
usually only recognized properly by the BIOS or UEFI, when in the BIOS/UEFI the
221+
feature AHCI has been activated for SATA (instead of IDE). Modern computers has
222+
as default, so that's fine. But on old machines the default might/could be IDE.
223+
About ARM based computers this are not a problem, when used SATA interfaces, but
224+
EMMC ones could need tune up cos are threated as Flash drives.
225+
226+
On SSDs, the cleaning action TRIM is recommended for the good performance in
227+
the long run. Otherwise it might become slow after some time. Very old SSD's from
228+
before 2010 usually don't support TRIM.
229+
230+
On SSDs Hibernation (suspend-to-disk) causes a huge amount of write actions,
231+
|omv| is a server system so xpected to stay always on or off.
232+
233+
Partition table technical details
234+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
235+
236+
Of course, the supported partition tables will depend on the installation mode,
237+
and |omv| can handle any type of partition table supported by the Debian operating
238+
system. This is because to manage shares on new or uninitialized storage drives
239+
it will need to create partitions or at least read structure of thems.
24240

25-
If you use a Flash Drive, select one with static wear leveling [6]_, without
26-
this the drive will have a very short lifetime. It is also recommended to
27-
install and activate the :ref:`Flash Memory plugin <plugin_3rd_party>`. The
28-
entire disk is used as system disk and can not be used to store user data.
29241

30242
.. [1] https://en.wikipedia.org/wiki/Paging
31243
.. [2] https://en.wikipedia.org/wiki/Solid-state_drive
32244
.. [3] https://en.wikipedia.org/wiki/Solid-state_drive#DOM
33245
.. [4] https://en.wikipedia.org/wiki/CompactFlash
34246
.. [5] https://en.wikipedia.org/wiki/USB_flash_drive
35247
.. [6] https://en.wikipedia.org/wiki/Wear_leveling
248+
.. [7] https://forum.openmediavault.org/index.php?board/29-guides/
249+
.. [8] https://en.wikipedia.org/wiki/Multi-channel_memory_architecture
250+
.. [9] https://www.debian.org/intro/about.en.html#what

0 commit comments

Comments
 (0)