README.format.txt 1.14 KB
Newer Older
1
Format
2
======
Łukasz Nowak's avatar
Łukasz Nowak committed
3

4
slapformat is an application to prepare SlapOS-ready node to be used inside SlapGrid Cloud.
Łukasz Nowak's avatar
Łukasz Nowak committed
5 6 7 8 9 10

It "formats" the machine by:

 - creating users and groups
 - creating bridge interface
 - creating needed tap interfaces
11
 - creating TUN interfaces
Łukasz Nowak's avatar
Łukasz Nowak committed
12
 - creating needed directories with proper ownership and permissions
13
 - (optional-manager) creating cgroup resource tree for slapos
Łukasz Nowak's avatar
Łukasz Nowak committed
14

15 16 17 18 19 20 21 22 23 24 25 26 27
It reads configuration from /etc/opt/slapos/slapos.cfg and formats computer
accordingly. The variables are number of partitions, IP addresses, storages
and network interfaces.

Format uploads a into configured SlapOS Master server.

Format dumps allocated resources for the partition into a JSON file per 
partition ~/.slapos-resource. This file contains network interfaces, 
IP address ranges and port ranges. The resource constraints can be 
recursively folded. 

Pluggable parts for formatting are available too. They are called Managers
and can be turned on/off via configuration property manager_list.
Łukasz Nowak's avatar
Łukasz Nowak committed
28 29 30 31

This program shall be only run by root.

Requirements
32
------------
Łukasz Nowak's avatar
Łukasz Nowak committed
33 34 35 36 37 38 39 40 41

Linux with IPv6, bridging and tap interface support.

Binaries:

 * brctl
 * groupadd
 * ip
 * useradd