Improve a bit documentation...

So that it is a least correct rst.
parent 708ae40d
slapprepare slapprepare
*********** ***********
Slapprepare is the script responsible to prepare a openSUSE computer to run slapos as a dedicated machine. Slapprepare is the script responsible of preparing an openSUSE computer to run slapos as a dedicated machine.
Process Process
------------------------------------------- -------------------------------------------
...@@ -9,51 +9,47 @@ Process ...@@ -9,51 +9,47 @@ Process
2. Add slapos repositories with zypper 2. Add slapos repositories with zypper
3. Install latest version of slapos but will deactivate slapos-node service 3. Install latest version of slapos but will deactivate slapos-node service
(Wait till everything is ready) (Wait till everything is ready)
4. If option --update or -u wasn't choosen slapprepare will consider 4. If option --update (-u) is given, it will skip the initial configuration step (disk formatting, etc)
it need to prepare computer like a newborn one 5. Will ask a few questions:
-It is a first run and ask a few question a user:
* "Automatically register new computer to Vifib?" (Default is yes) * "Automatically register new computer to Vifib?" (Default is yes)
is yes choosen two more question will follow: is yes choosen two more question will follow:
"Define a unique name for this computer:" * "Define a unique name for this computer:"
Unique name to register computer on Vifib Master * "Number of SlapOS partitions for this computer? Default is 20 :"
"Number of SlapOS partitions for this computer? Default is 20 :"
Partition amount for this computer
* "Is this a virtual Machine?" (Default is False) * "Is this a virtual Machine?" (Default is False)
Is it a virtual machine? Default is false
* If not a virtual machine: * If not a virtual machine:
"Do you want to use SlapOS with a second disk?" (Default is True)
If True selected the script slapos_firstboot will be run searching * "Do you want to use SlapOS with a second disk?" (Default is True)
for second a second disk. If True selected the script slapos_firstboot will be run searching
for second a second disk.
* "Do you want to use vpn to provide ipv6?" (Default is Yes) * "Do you want to use vpn to provide ipv6?" (Default is Yes)
If False selected will remove openvpn-needed file in config directory If False selected will remove openvpn-needed file in config directory
* "Do you want to force the use lxc on this computer?" (Default is No) * "Do you want to force the use lxc on this computer?" (Default is No)
If Yes choosen will run "# touch /etc/opt/slapos/SlapContainer-needed" If Yes choosen will run "# touch /etc/opt/slapos/SlapContainer-needed"
* "Do you want a remote ssh access?" (Default is Yes) * "Do you want a remote ssh access?" (Default is Yes)
If yes is choosen, will later ask for a web address If yes is choosen, will later ask for a web address
to download user' public ssh key and put it in root authorized_keys to download user' public ssh key and put it in root authorized_keys
-If automatically register to vifib was choosen
it will run slapos node register which prepare slapos configuration 6. If automatically register to vifib was choosen, it will run slapos node register which prepare slapos configuration
-Display computer's reference ("Your Computer is : COMP-1234") 7. Display computer's reference ("Your Computer is : COMP-1234")
-If remote ssh access was choosen will ask for public key address 8. If remote ssh access was choosen will ask for public key address and download it.
and download it. 9. Will prepare computer:
-Will prepare computer: * Setting hostname
* Setting hostname * Adding the hostname as a valid address
* Adding the hostname as a valid address * Creating safe sshd_config
* Creating safe sshd_config * Creating default bridge config
* Creating default bridge config * If remote ssh: Writing ssh key
* If remote ssh: Writing ssh key * Adding slapos_firstboot in case of MultiDisk usage
* Adding slapos_firstboot in case of MultiDisk usage
- If multi-disk usage it will run slapos_firstboot and reinstall slapos 10. If multi-disk usage it will run slapos_firstboot and reinstall slapos
5. It will install boot script that are not included in package 11. It will install boot script that are not included in package
- Boot script in "/usr/sbin/slapos-boot-dedicated"
and its associated service in: * Boot script in "/usr/sbin/slapos-boot-dedicated" and its associated service in:
"/etc/systemd/system/slapos-boot-dedicated.service" "/etc/systemd/system/slapos-boot-dedicated.service"
- clientipv4 (openvpn conf) * clientipv4 (openvpn conf)
- Remove script form older versions of slapprepare * Remove script form older versions of slapprepare
6. Configure NTP daemon
7. "#systemctl enable slapos-boot-dedicated.service" 12. Configure NTP daemon
"#systemctl start slapos-boot-dedicated.service" 13. Will enable an start slapos-boot-dedicated service
Will activate an start slapos-boot-dedicated
About slapos-boot-dedicated About slapos-boot-dedicated
------------------------------------------- -------------------------------------------
...@@ -69,8 +65,7 @@ Process ...@@ -69,8 +65,7 @@ Process
6. If slapos.cfg is not in /etc/opt/slapos/ it correct path in package 6. If slapos.cfg is not in /etc/opt/slapos/ it correct path in package
script and cron file script and cron file
7. Set dedicated cron file "/etc/cron.d/slapos" 7. Set dedicated cron file "/etc/cron.d/slapos"
- If SlapContainer-needed file in configuration directory will add a line - If SlapContainer-needed file in configuration directory will add a line to use it
to use it
8. Set various parameters to improve running performance of slapos 8. Set various parameters to improve running performance of slapos
...@@ -96,15 +91,19 @@ http://git.erp5.org/gitweb/slapos.core.git/blob_plain/HEAD:/slapos.cfg.example ...@@ -96,15 +91,19 @@ http://git.erp5.org/gitweb/slapos.core.git/blob_plain/HEAD:/slapos.cfg.example
Check dedicated cron file Check dedicated cron file
+++++++++++++++++++++++++ +++++++++++++++++++++++++
# less /etc/cron.d/slapos ::
# less /etc/cron.d/slapos
It should contain a call to slapupdate It should contain a call to slapupdate
Check your configuration directory Check your configuration directory
++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++
# ls /etc/opt/slapos/ ::
# ls /etc/opt/slapos/
It should only contain your slapos configuration files and *-needed files It should only contain your slapos configuration files and \*-needed files
Configure your machine: Configure your machine:
...@@ -120,6 +119,3 @@ openvpn ...@@ -120,6 +119,3 @@ openvpn
Openvpn by vifib for ipv6 is forced by default in the package. Openvpn by vifib for ipv6 is forced by default in the package.
- If you want to deactivate it run - If you want to deactivate it run
# rm /etc/opt/slapos/openvpn-needed # rm /etc/opt/slapos/openvpn-needed
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment