Commit Graph

61 Commits (37600660f3ec54d9221c76d3de72f64cb6de85fc)

Author SHA1 Message Date
Alejandro Sirgo Rica 37600660f3 live: check if cache partition is available before calling tiptorrent
The image restore command must check if the cache partition is
available. Otherwise if the user forgets to create the cache
tiptorrent fails.
2024-03-21 10:29:06 +01:00
Alejandro Sirgo Rica 4d4171e459 utils: move all boot from OS functionality into boot.py
This change is a preparative for reimplementing the BIOS boot
in order to deprecate the legacy script. All the codepaths to
boot systems located at a partition are now called from the
boot_os_at function enabling an easier structure for the incoming
code.
2024-03-08 13:03:00 +01:00
Alejandro Sirgo Rica 7f18485eff utils: improve uefi detection mechanism
Checking the existence /sys/firmware/efi as it might appear
sometimes in BIOS installs if the BIOS configuration is not
proper. Checking for the EFI partition is the safest method
to veryfy the install type.
2024-03-08 12:43:10 +01:00
Jose M. Guisado 23b4b1feb6 live: drop IniciarSesion script when uefi booting
Replace IniciarSesion script in favor of native Python code when booting
a UEFI system. This applies when running the "session" command.

WIP: Only UEFI boots Windows systems. Raise NotImplementedError
exception trying to boot a Linux system using UEFI.
2024-03-04 11:33:10 +01:00
OpenGnSys Support Team e3bb01f5f1 live: improve logging with setup command
Improve logging when setting up partition, provide more hints on progress.

Fail in case partition layout is not supported.
2024-02-22 11:33:50 +01:00
OpenGnSys Support Team 92ef3d68aa live: call partprobe on the specific disk
otherwise partprobe does its best to find the disk, according to what I see
through strace.
2024-02-19 11:56:25 +01:00
OpenGnSys Support Team dbda6abd22 poweroff: always call poweroff_oglive and _reboot_oglive
Remove leftover fallback to directly call utilities to poweroff and reboot.
2024-02-19 10:07:27 +01:00
OpenGnSys Support Team 4109bb6ecc live: split logging to warn not to turn off client during image creation
just split this log message.
2024-02-15 16:58:51 +01:00
OpenGnSys Support Team 2da8b98fff fs: check if writing md5sum to full.sum file fails
writing to file might fail (permission denied, disk full), check for errors.
2024-02-15 16:58:51 +01:00
OpenGnSys Support Team 0fc7f8f33e src: ogChangeRepo returns zero on success and -1 on error
do not return the returncode, instead return an integer.

do not use

	except CalledProcessError as e:

it causes a another exception while handling exception.

Remount the original image repository.

it should be possible to simplify this further by:

- stacking mounts, no need to umount initial repo and mount it again
  when switching to the new repo, because remount back initial repo
  might fail (!)

- use check=False and simply check for x.returncode
2024-02-15 16:22:23 +01:00
OpenGnSys Support Team 44250d0334 live: remove mbuffer leftover in image restore command
Remove mbuffer, this is never used.

mbuffer has been never been used since ogClient supports native image restore.

Originally this was used like this:

	partclone [...] | mbuffer -q -M 40M | lzop [...]

supposely to speed up partclone in case the device where the read happens is
slowier than the device that is used for writes.

See mbuffer(1) manpage examples.

In any case, this needs benchmarking to really make sure this is helping.

Remove it until that ever happens.
2024-02-15 16:22:23 +01:00
OpenGnSys Support Team 6b1f20faf3 live: log message improvements for image creation and restore
Provide more context information for debugging issues with image creation and
restore.
2024-02-15 16:22:13 +01:00
Alejandro Sirgo Rica 478c4447be src: improve error check in image_create and image_restore
cover more error cases where exceptions need to be raised.
check return code in the invoked subprocess.

restoreImageCustom has been intentionally left behind, it
is unclear what this custom script returns on success and
error.
2024-02-14 12:28:28 +01:00
Alejandro Sirgo Rica c1529c5eec src: fix whitespace in ogOperations.py
make whitespace conherent with the rest of the file contents.
2024-02-14 11:09:54 +01:00
OpenGnSys Support Team 9beb55894d live: refine existing logging
- suggest to check permissions in samba folder
- fix typo, s/filesyste/filesystem/
2023-12-18 13:47:29 +01:00
OpenGnSys Support Team 32673cf337 live: adding logging to notify that image file already exists
Just informational, provide a notice that the file already exists.
2023-12-17 20:53:43 +01:00
OpenGnSys Support Team dff126cf40 live: ensure image file exists after partclone
check that there is a file and that is accessible
2023-12-17 11:27:28 +01:00
OpenGnSys Support Team 2bddf205d9 live: display filesystem and device path if image_create() fails
display filesystem and path to device.
2023-12-16 17:15:34 +01:00
OpenGnSys Support Team 5d19ff5fe9 live: validate rw access to image folder after remount
check that it is readable and writable
2023-12-16 17:14:02 +01:00
OpenGnSys Support Team 6c49815d73 live: report permissions and last update when creating image
add .permissions and .lastupdate to json to report to ogserver.
2023-12-12 17:51:50 +01:00
OpenGnSys Support Team b97c4d157a live: report image size when creating image
add .size json field to report the real size of the image file.
2023-12-12 11:33:48 +01:00
Jose M. Guisado 4e10c46563 live: use legacy backup image suffix
Image backup is considered a legacy feature. Use the legacy mechanism of
naming image backups by adding ".ant" suffix.

Previously, by using the strftime suffix clients were reporting that the
disk were getting full rather quickly.

When a good method for image deletion is implemented then a proper
backup naming mechanism should be reconsidered.
2023-10-24 09:56:09 +02:00
Jose M. Guisado 49038f125a src: improve logging messages
Some users have mistakenly reported tiptorrent problems when the process
takes a long time. Specifically by rebooting or powering off the client
in the middle of the md5sum computation stage, just after the tiptorrent
transfer.

Same problem occurs when image creation command takes a long period of
time.

In order to help the user understand the different stages of commands
such as image creation or image restore using tiptorrent, the following
changes have been made to the current logging solution:

- Add log messages to warn users not to reboot or shut down the client
  during a tiptorrent transfer, and also during the md5sum computation
  stage.

- Add a log message telling the user that the image creation processes
  have started.

- Use logging.exception inside "except:" blocks to print a traceback
  with the log messsage.
  (https://docs.python.org/3/library/logging.html#logging.exception)
2023-08-01 18:26:10 +02:00
Jose M. Guisado 035995fc8c live: add image backup option in image creation
Backup image file if image creation request included

	"backup": true

This only applies when the target image is already present in the
repository folder before running the partclone subprocess.

This parameter is ignored if the target image is not present in the
repository.
2023-07-06 17:52:52 +02:00
Jose M. Guisado fa51f2be8f src: remove unused legacy software inventory code
Remove unnecessary InventarioSoftware invocation inside image_create
operation. Software inventory is executed after image creation
(see ogRest.py).

Remove legacy 'path' parameter. This parameter was used to specify the
path of a text file in which legacy bash scripts wrote the software
inventory of the client (something like "Csft-{ip}...").

Fixes: 04bb35bd86 ("live: rewrite software inventory")
Fixes: 2e3d47b7b8 ("Avoid writting /software output to a file")
2023-05-17 12:44:50 +02:00
Jose M. Guisado 66a464f7d0 live: rewrite reboot operation
Add optional 'operation' parameter to _poweroff_oglive function.
Reuse _poweroff_oglive code before the busybox subprocess when rebooting
an ogLive client.
2023-05-09 13:09:07 +02:00
Jose M. Guisado ef06618a8c live: rewrite poweroff operation
Replace legacy bash script /opt/opengnsys/client/scripts/poweroff with a
Python native solution.

Use subprocess module for any required external program when shutting
down a client. ethtool is used to ensure WoL setting is correct before
shutting down.

ogLive does not properly use a init system so busybox is used when
shutting down the system. In other live environments poweroff operation
just calls /sbin/poweroff.
2023-05-09 13:09:07 +02:00
Jose M. Guisado ee80dc89ad live: rewrite hardware inventory command
Replace legacy shell script InventarioHardware for helper functions
from hw_inventory.py

Use get_hardware_inventory to obtain a HardwareInventory object with
the hardware information. Map the HardwareInventory object to a legacy
response string with the legacy_list_hardware_inventory function.

Remove "Chrd-*" file reading logic, it's no longer needed. Legacy shell
script InventarioHardware uses that file.

Expect a change in the structure of hardware inventory response payload
in the future. This patch does not address the HTTP response containing
the hardware inventory as a '\n' separated string of hardware elements.
2023-04-18 17:15:57 +02:00
Jose M. Guisado 4c0904d8da utils: rename inventory.py to sw_inventory.py
Rename software inventory file to sw_inventory to better distinguish
it from a future hardware inventory code.

In the future sw_inventory and hw_inventory might be merged together
once each file is tidied up.
2023-04-18 10:58:00 +02:00
Jose M. Guisado 04bb35bd86 live: rewrite software inventory
Replace legacy bash script in favor of Python code. Improves error
traceability and further development.

The software inventory operation mounts the target partition and it
fetches the list of installed software (package set). Once the
operation is complete, it unmounts the target partition.

For Windows, introduce hivex library python bindings for accessing
Windows registry hive files (https://libguestfs.org/hivex.3.html).

This operation is still processed by legacy code in the server side
(ogAdmServer.c in ogServer). Legacy backend process expects the software
inventory like the following example:

"software": "Windows 10 Enterprise Evaluation 2004 \nIntel(R) Network Connections 24.0.0.11 24.0.0.11 ..."

The os name is inserted first in this list followed by a '\n' separated
string of the software packages.

The legacy server code can be found in function actualizaSoftware at
ogServer/src/ogAdmServer.c

It is expected for software inventory payload to change in the future to
a simpler solution using just a json array of strings.
2023-03-27 15:48:03 +02:00
Jose M. Guisado 2172f00cde live: fix ogChangeRepo invocation
Add missing samba credentials parameter in ogChangeRepo invocation.

Credentials are loaded from ogClient config file.

Any production deployment should use its own samba user and password.
ogChangeRepo fails when using default samba credentials in a production
environment.

Fixes: a1edbe904b ("legacy: rewrite ogChangeRepo")
Fixes: 3703fd6063 ("live: support native unicast cache image restore")
2023-03-27 15:48:03 +02:00
Jose M. Guisado c0e14e0c95 live: fix unicast cache error log message
Removes undefined 'repo' variable from error logging message.

This caused the traceback to be polluted with an unhelpful message
about this variable being undefined.

Fixes: 3703fd606 ("live: support native unicast cache image restore")
2023-03-27 15:48:03 +02:00
Jose M. Guisado a1edbe904b legacy: rewrite ogChangeRepo
Drop ogChangeRepo Bash script in favor of a native Python
approach. Use only necessary subprocess calls instead of bringing
all the logic of this function into a Bash script black box.

ogChangeRepo unmounts the current OpenGnsys image samba folder
(/opt/opengnsys/images) and mounts (connects to) a new directory using
the new provided ip address. Keeping access mode from previous mount.
If anything goes wrong when mounting the new directory, it will fallback
to mounting the previous directory.

If no previous OpenGnsys image samba directory is detected, this
functions tries to mount the new directory anyway. In this case,
it will raise CalledProcessError if something goes wrong.
2023-03-02 09:33:33 +01:00
Jose M. Guisado 782f46a199 live: rewrite setup operation
Rewrites the setup operation using python-libfdisk module instead of an
external bash script. Consolidating the operation into Python's code,
limiting external subprocesses to well known programs and small
concrete tasks that are difficult to fully integrate into Python.

Use parttypes.py to fetch partition types from python-libfdisk module.
Use fs.py to create any specified supported filesystem.

OpenGnsys cache partitions are created labelling the partition as
"CACHE". Stops setting non-standard MBR hexcode (0xca) to the cache
partition in addition to the filesystem label.

Any partition specified as type EMPTY will be ignored.
2023-02-09 13:26:06 +01:00
Jose M. Guisado c010c42008 live: clear ogbrowser log before image_create
Remove any previous unrelated log message shown in the "real time log"
html page before executing this command.
2022-12-05 16:37:35 +01:00
Jose M. Guisado 70f1d0d71d live: clear ogbrowser logs before image_restore
Clears content of blue text areas in the real time log view before
executing a restore image operation.

Adds private function _ogbrowser_clear_logs, this function writes to a
couple of text files present in the ogLive environment.
The contents of this file are printed out to the blue text areas
in the "real time log" view.
2022-12-01 15:22:58 +01:00
Jose M. Guisado 699a6c242a live: improve error paths
Fix error paths in live operations which do not
reset the "browser" to the main page (one with the menu).

Add error logging messages when:

* _restartBrowser fails.
* ogChangeRepo fails.

Improve checksum fetch error handling. For example, when an invalid
repository IP is specified.
2022-11-17 15:55:42 +01:00
Jose M. Guisado 3703fd6063 live: support native unicast cache image restore
UNICAST-CACHE consist of:

1. Checking if the target image is already present at the opengnsys
   cache partition. If so, check for integrity (local and remote
   checksum). If the image is not present in the cache partition,
   download the target image into it.
2. Restore the image from cache partition.

This commit add support for this operation natively from ogClient
Python's code.
2022-11-02 14:09:39 +01:00
Jose M. Guisado f2515fcde9 live: don't use python open() when reading image
Specifies the image path in the lzop subprocess string.

It might be interesting to study efficient mechanisms to read large
binary files in python before using open() with default parameters for
buffered binary reading.
2022-09-23 12:12:35 +02:00
Jose M. Guisado 00a95bdb61 live: rewrite image_restore
Integrates image restore command into native ogClient code. Further
reduces the need for external Bash scripts.

After a succesful image restore, OS configuration is still using
external Bash script "osConfigure/osConfigureCustom".
2022-09-14 17:12:14 +02:00
Jose M. Guisado 87e738b33f image_restore: fix ogCopyEfiBootLoader
ogCopyEfiBootloader is an invalid legacy bash function name.

Rename to the correct function name 'ogCopyEfiBootLoader' and
rename utility python wrapper too.

Fixes: 0bd037c1a409c65fbcb01355ee0dd6dca770330e
2022-09-14 17:12:14 +02:00
Jose M. Guisado 91077da273 utils: minor fix for ogReduceFs and ogExtendFs
Do not return the subprocess result for ogReduceFs/ogExtendFs.

ogReduceFs works with or without the target filesystem mounted.
ogExtendFs requires the target filesystem to be mounted.

'ogMount' legacy script invocation should be replaced by a better
mount/umount wrapper.
2022-09-14 17:12:14 +02:00
Jose M. Guisado cb0bd3d194 image_create: add legacy ogCopyEfiBootloader
Use legacy script that saves the Windows-specific content from the ESP
to the image target filesystem.

Current image restore solution from OpenGnsys scripts expect the EFI
partition to be stored in the target system partition. (Only for Windows
10)

For example, storing the ESP in the NTFS partition of a Windows image.

Expect use of bash script ogCopyEfiBootloader until further
integration is merged.
2022-09-14 17:10:45 +02:00
Jose M. Guisado 3550da73e6 image_create: partial integration into python
Integrates some parts of this operation into native code, eg: the md5
checksum computation.

Wraps non native processes and commands using the subprocess module.
For example, legacy.py stores bash commands pending integration.

Supports python >=3.6, expected until more modern ogLives are put into
production environments.
2022-08-24 09:48:35 +02:00
Jose M. Guisado 74a61d6a7d refresh: use '0' if disk has no label
If disk has no label, python-libfdisk returns None when accessing

	cxt.label

Fixes bug when running refresh on computers whose disk/s have no label.
2022-08-22 17:05:12 +02:00
Jose M. Guisado 1b5281c2a1 live: enable details for libfdisk context object
Enables details in libfidsk context constructor call. Ensures size are
displayed as bytes (and not as a human readable string).

Avoids further arithmetical errors (e.g: converting from bytes to KB)
2022-06-08 10:27:06 +02:00
Jose M. Guisado c159c76294 live: remove unused parseGetConf function
parseGetConf was necessary for parsing output from OpenGnsys
script "getConfiguration", which has been replaced since commit
1ab981a539 ("live: replace getConfiguration with refresh")
2022-06-08 10:27:06 +02:00
Jose M. Guisado 30fdcceea3 src: improve logging
Adds new logging handler redirecting messages to the log file
located in the Samba shared directory (applies to live mode
clients, i.e: ogLive)

Parses log level configuration from ogclient.json. See:

{
	"opengnsys": {
		...
                "log": "INFO",
		...
	}
	...
}

Adds --debug option to set root logger level to DEBUG when starting
ogClient. Overrides log level from config file.

In addition:

- Replaces any occurence of print with a corresponding logging function.
- Unsets log level for handlers, use root logger level instead.
- Default level for root logger is INFO.
- Replaces level from response log messages to debug (ogRest)
2022-06-08 10:27:06 +02:00
Jose M. Guisado 1ab981a539 live: replace getConfiguration with refresh
Old refresh was a wrapper around getConfiguration bash script.

New refresh operation does what getConfiguration used to do
externally. See commit 097769b971.
2022-06-01 11:48:30 +02:00
Javier Sánchez Parra 6c441e94e2 live: assume VFAT is always FAT32
fdisk reports VFAT, however, OpenGnsys does not have such entry in the
filesystem table. Add an alias to FAT32 as a workaround.
2022-06-01 11:48:30 +02:00