Merge pull request #12 from darrenldl/dev

Added main menu

Author: darrenldl

.travis.yml

@@ -24,14 +24,14 @@ script:
   - docker exec installer_builder bash -c 'cp -r ~/oali-master ~/oali'
   - docker exec installer_builder bash -c 'chmod u=rwx ~/oali'
   - docker exec installer_builder bash -c 'eval $(opam env); cd ~/oali/installer_ml; make'
-  - docker cp installer_builder:/home/opam/oali/installer_ml/_build/default/src/installer.exe ./installer
-  - strip installer
+  - docker cp installer_builder:/home/opam/oali/installer_ml/_build/default/src/oali.exe ./oali
+  - strip oali
 
 deploy:
   provider: releases
   api_key:
     secure: iSx+Ztrz9rI97R3waKGM3Lv8GehszPnjEEdY7U2wePRbOwXrdlTohoIotyGY1TbfyluzOKF51tvctpJbezRWEPUGQb173C+nv35o/fHiN6CGDT77DUzqEtFYEBlb6o4sUPtRTkKaD1qw7Jei7ttk+CDA4zRmyd/fdp/krdNdyFVYzlXklobt3+XRikRxmHioxfI9vd7AJp4VebO+4UmC9Ja7HLu7UiHtwxZOJHvpS0NFaaucN7RsgFIYQLf+pPca6M0RFSuBUS4xCA+D27/sTEjGpQicVu50uI4sMpJx2rzqf4m2OW1IERn+p2tegMofJBTxPqQERG1N1nmzbOGYKp3u9WJsV5/XmbvWrXk9LV5DbkDn7v6lkKSby905FFgqAVKxtE2VXib0rGBIJ/kHcgoz1Bvt3t6uHUMCV4R8azy400NesqpRDZc6ocKFleKEvDkYJQB5INWLUiu9rLpV2wEPjNV56EY7zULgbwlHCedKtVoHT7SCpVb6Gt4onr/GqrKKdC+0jiNWbfyKoYfNbDAonSt/mhgA4GIG/6D5/2O1hkymbtAsiOCkrPyVlh/9p8sTiWg6DxkNANkqHasn+uJPWaXKKjhSSzWuwS516uqdVdyj3xUjiyMNLeIrSvYJwbJKN4zfogsYXvHrwj7WwAqX0DV3otweCGtZt8LpWYU=
-  file: installer
+  file: oali
   on:
     tags: true
     repo: darrenldl/oali

CHANGELOG.md

@@ -5,6 +5,7 @@
   - Previously partition name may not be correctly deduced during formatting
 - Added task unit for using `reflector` to generate more optimised mirrorlist
 - Added SSH server setup and SSH keys transfer code
+- Added a very rough main menu
 
 # 0.0.2
 - Added following user options when task unit fails

README.md

@@ -17,28 +17,41 @@ Oali is an installer written in OCaml which sets up a Arch Linux installation wi
 - Optional full disk encryption
 - Optional `linux-hardened` kernel installation
 
-Oali aims to be smart and hassle free, so following features are included as a result
-- Automatic adjustment of dialogues and settings based on whether the live CD is running in UEFI or BIOS mode
+Overall oali aims to be snappy, minimal, smart, and hassle free. See **Specifics** section below for more information.
 
-## Prerequisites
+## Getting started
+#### Prerequisites
 - Working internet connection
 - Partitioning done for system partition
 - USB key (data will be lost)
 
-## Space requirement
+#### Space requirement
 - USB key (if you intend to use disk layout that utilises a USB key)
   - 1 GiB USB drive will be very sufficient
 - System drive
   - Current salt states download/install around 10 GiB of data
 
-## Instructions
+#### Instructions
 The OCaml code is not self contained, thus if you choose to compile it yourself, you will need to install various dependencies.
 
 For deployment purposes, it is recommended that you use the static binaries provided, which you can download via [GitHub releases](https://github.com/darrenldl/ocaml-linux-installer/releases)
 
 The static binaries of the installer are built via Travis CI using `ocaml/opam2:alpine` Docker image, and should be able to run on Arch Linux live CD without any further setup
 
+## Answers to some "Why?" questions
+- Why make an installer to begin with?
+  - Mildly complex FDE setups are really laborious and error prone to set up, and unfortunately you can't really afford human errors during these set ups depending on the nature of installation
+  - A lot of decisions are based on information processing and very mechanical - no point in having a human devoted to repeating deterministic steps
+- Why not bash?
+  - The previous iteration of this installer was written in bash actually (see `scripts/setup.sh`), but it only supported one disk layout and always have encryption
+  - Adding a lot of decision making code and information handling code to bash code was really tedious and difficult
+- Why OCaml?
+  - I know I can do OCaml/Rust reasonably fast, but slow to a crawl with dynamically typed langs
+  - Here is mostly a lot of handling of immutable information (e.g. processing of system information), where Rust doesn't carry a significant advantage over OCaml, and the overhead didn't seem worth it to me
+
 ## Specifics
+#### EFI/BIOS
+Oali automatically adjusts dialogues and settings based on whether the live CD is running in UEFI or BIOS mode
 
 #### Disk layout choices
 **Single system disk** - Oali slices the disks into ESP (if in EFI mode), boot and root partitions automatically

installer_ml/Makefile

@@ -22,7 +22,7 @@ all : exe
 
 .PHONY: exe
 exe:
-	dune build src/installer.exe
+	dune build src/oali.exe
 
 .PHONY: format
 format :

installer_ml/src/disk_utils.ml

@@ -1,4 +1,7 @@
+let sync () = Proc_utils.exec "sync"
+
 let list_disk_block_devs () =
+  sync ();
   let dir = "/dev/disk/by-path/" in
   let paths = Sys.readdir dir |> Array.to_list in
   let dsts =
@@ -78,5 +81,3 @@ let uuid_of_dev dev =
   |> List.filter (fun (s, _) -> s = Filename.basename dev)
   |> List.hd
   |> fun (_, uuid) -> uuid
-
-let sync () = Proc_utils.exec "sync"

installer_ml/src/dune

@@ -1,5 +1,5 @@
 (executable
- (name installer)
+ (name oali)
  (libraries core_kernel
             sexplib
             re

installer_ml/src/installer.ml installer_ml/src/oali.mlinstaller_ml/src/installer.ml renamed to installer_ml/src/oali.ml

@@ -258,7 +258,6 @@ let () =
                disk boot_part_end_MB
                (frac_to_perc Config.total_disk_usage_frac));
           exec (Printf.sprintf "parted %s set 1 boot on" disk);
-          Disk_utils.sync ();
           let parts = Disk_utils.parts_of_disk disk in
           let esp_part_path = List.nth parts 0 |> Option.some in
           let boot_part_path = List.nth parts 1 in
@@ -283,7 +282,6 @@ let () =
                disk boot_part_end_MB
                (frac_to_perc Config.total_disk_usage_frac));
           exec (Printf.sprintf "parted %s set 1 boot on" disk);
-          Disk_utils.sync ();
           let parts = Disk_utils.parts_of_disk disk in
           let boot_part_path = List.nth parts 0 in
           let sys_part_path = List.nth parts 1 in
@@ -428,7 +426,6 @@ let () =
             (Printf.sprintf "parted -a optimal %s mkpart primary %dMB %dMB"
                usb_key boot_part_beg_MB boot_part_end_MB);
           exec (Printf.sprintf "parted %s set 1 boot on" usb_key);
-          Disk_utils.sync ();
           let parts = Disk_utils.parts_of_disk usb_key in
           let esp_part_path = List.nth parts 0 |> Option.some in
           let boot_part_path = List.nth parts 1 in
@@ -448,7 +445,6 @@ let () =
             (Printf.sprintf "parted -a optimal %s mkpart primary 0%% %dMB"
                usb_key boot_part_end_MB);
           exec (Printf.sprintf "parted %s set 1 boot on" usb_key);
-          Disk_utils.sync ();
           let parts = Disk_utils.parts_of_disk usb_key in
           let boot_part_path = List.nth parts 0 in
           let disk_layout =
@@ -893,8 +889,7 @@ let () =
       {config with enable_ssh_server = Some enable_ssh_server});
   reg ~name:"Installing SSH server" (fun config ->
       Arch_chroot.install ["openssh"];
-      config
-    );
+      config);
   reg ~name:"Copying sshd_config over" (fun config ->
       FileUtil.cp [Config.sshd_config_path_in_repo] Config.etc_ssh_dir_path;
       config);
@@ -930,8 +925,9 @@ let () =
             ip port otp;
           print_endline "or";
           Printf.printf
-            "cat PUBKEY | gpg --batch --yes --passphrase %s -c | ncat %s %d\n"
+            "    cat PUBKEY | gpg --batch --yes --passphrase %s -c | ncat %s %d\n"
             otp ip port;
+          print_newline ();
           exec (Printf.sprintf "ncat -lp %d > %s" port recv_dst_path);
           print_newline ();
           print_endline "File received";