From 48e663249d4595fa671710291ee11412c3f04f18 Mon Sep 17 00:00:00 2001 From: Jenni Nikolaenko Date: Tue, 29 Oct 2024 18:06:31 +0200 Subject: [PATCH] Docs: add ghaf-24.09 and ghaf-24.09.1 release notes Signed-off-by: Jenni Nikolaenko --- docs/src/SUMMARY.md | 4 +- .../src/ref_impl/reference_implementations.md | 6 +- docs/src/release_notes/ghaf-23.09.md | 2 +- docs/src/release_notes/ghaf-23.12.md | 2 +- docs/src/release_notes/ghaf-24.03.md | 2 +- docs/src/release_notes/ghaf-24.06.md | 2 +- docs/src/release_notes/ghaf-24.09.1.md | 74 +++++++++++++++ docs/src/release_notes/ghaf-24.09.md | 94 +++++++++++++++++++ docs/src/release_notes/release_notes.md | 2 + docs/src/troubleshooting/troubleshooting.md | 2 +- 10 files changed, 183 insertions(+), 7 deletions(-) create mode 100644 docs/src/release_notes/ghaf-24.09.1.md create mode 100644 docs/src/release_notes/ghaf-24.09.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 8962d610e..916931b11 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -36,7 +36,7 @@ - [IDS VM Further Development](ref_impl/idsvm-development.md) - [systemd Service Hardening](ref_impl/systemd-service-config.md) - [Troubleshooting](troubleshooting/troubleshooting.md) - - [Analyzing System Logs](troubleshooting/systemd/systemd-analyzer.md) + - [Analyzing System Logs](troubleshooting/systemd/system-log.md) - [Debugging systemd Using systemctl](troubleshooting/systemd/systemctl.md) - [Inspecting Services with systemd-analyze](troubleshooting/systemd/systemd-analyzer.md) - [Using strace for Debugging Initialization Sequence](troubleshooting/systemd/strace.md) @@ -66,6 +66,8 @@ - [Public Key Infrastructure](scs/pki.md) - [Security Fix Automation](scs/ghaf-security-fix-automation.md) - [Release Notes](release_notes/release_notes.md) + - [Release ghaf-24.09.1](release_notes/ghaf-24.09.1.md) + - [Release ghaf-24.09](release_notes/ghaf-24.09.md) - [Release ghaf-24.06](release_notes/ghaf-24.06.md) - [Release ghaf-24.03](release_notes/ghaf-24.03.md) - [Release ghaf-23.12](release_notes/ghaf-23.12.md) diff --git a/docs/src/ref_impl/reference_implementations.md b/docs/src/ref_impl/reference_implementations.md index c4896016a..d6de8712a 100644 --- a/docs/src/ref_impl/reference_implementations.md +++ b/docs/src/ref_impl/reference_implementations.md @@ -50,7 +50,11 @@ The same goes with the architectural variants as headless devices or end-user de - [IDS VM Further Development](./idsvm-development.md) - [systemd Service Hardening](./systemd-service-config.md) - [Troubleshooting](../troubleshooting/troubleshooting.md) - - [Troubleshooting with systemd](../troubleshooting/systemd/systemd_trblsh.md) + - [Analyzing system logs](./systemd/system-log.md) + - [Debugging systemd using systemctl](./systemd/systemctl.md) + - [Inspecting services with systemd-analyze](./systemd/systemd-analyzer.md) + - [Using strace for debugging the initialization sequence](./systemd/strace.md) + - [Early shell access](./systemd/early-shell.md) - [Ghaf as Library: Templates](./ghaf-based-project.md) - [Example Project](./example_project.md) - [Modules Options](./modules_options.md) diff --git a/docs/src/release_notes/ghaf-23.09.md b/docs/src/release_notes/ghaf-23.09.md index 46549e619..d7d8119f6 100644 --- a/docs/src/release_notes/ghaf-23.09.md +++ b/docs/src/release_notes/ghaf-23.09.md @@ -71,7 +71,7 @@ There are no specific requirements for the environment with this release. ## Installation Instructions -Released images are available at [ghafreleasesstorage.z16.web.core.windows.net/ghaf-23/](https://ghafreleasesstorage.z16.web.core.windows.net/ghaf-23/). +Released images are available at [ghafreleasesstorage.z16.web.core.windows.net/ghaf-23](https://ghafreleasesstorage.z16.web.core.windows.net/ghaf-23/). Download the required image and use the following instructions: diff --git a/docs/src/release_notes/ghaf-23.12.md b/docs/src/release_notes/ghaf-23.12.md index ac9d1a660..f43ad676d 100644 --- a/docs/src/release_notes/ghaf-23.12.md +++ b/docs/src/release_notes/ghaf-23.12.md @@ -76,7 +76,7 @@ There are no specific requirements for the environment with this release. ## Installation Instructions -Released images are available at [ghafreleasesstorage.z16.web.core.windows.net/ghaf-23-12/](https://ghafreleasesstorage.z16.web.core.windows.net/ghaf-23-12/). +Released images are available at [ghafreleasesstorage.z16.web.core.windows.net/ghaf-23-12](https://ghafreleasesstorage.z16.web.core.windows.net/ghaf-23-12/). Download the required image and use the following instructions: diff --git a/docs/src/release_notes/ghaf-24.03.md b/docs/src/release_notes/ghaf-24.03.md index 8e8a95b6c..cb45dbe65 100644 --- a/docs/src/release_notes/ghaf-24.03.md +++ b/docs/src/release_notes/ghaf-24.03.md @@ -70,7 +70,7 @@ There are no specific requirements for the environment with this release. ## Installation Instructions -Released images are available at [ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-03/](https://ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-03/). +Released images are available at [ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-03](https://ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-03/). Download the required image and use the following instructions: diff --git a/docs/src/release_notes/ghaf-24.06.md b/docs/src/release_notes/ghaf-24.06.md index 80baf0a4c..a41bac347 100644 --- a/docs/src/release_notes/ghaf-24.06.md +++ b/docs/src/release_notes/ghaf-24.06.md @@ -75,7 +75,7 @@ There are no specific requirements for the environment with this release. ## Installation Instructions -Released images are available at [ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-06/](https://ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-06/). +Released images are available at [ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-06](https://ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-06/). Download the required image and use the following instructions: diff --git a/docs/src/release_notes/ghaf-24.09.1.md b/docs/src/release_notes/ghaf-24.09.1.md new file mode 100644 index 000000000..e48ded9ad --- /dev/null +++ b/docs/src/release_notes/ghaf-24.09.1.md @@ -0,0 +1,74 @@ + + +# Release ghaf-24.09.1 + +This patch release is targeted at [Secure Laptop](../scenarios/showcases.md#secure-laptop) (Lenovo X1 Carbon) test participants and brings in new features and bug fixes. + +Lenovo X1 Carbon has been fully tested for this release, other platforms have been sanity-tested only. + + +## Release Tag + + + + +## Supported Hardware + +The following target hardware is supported by this release: + +* NVIDIA Jetson AGX Orin +* NVIDIA Jetson Orin NX +* Generic x86 (PC) +* Polarfire Icicle Kit +* Lenovo ThinkPad X1 Carbon Gen 11 +* Lenovo ThinkPad X1 Carbon Gen 10 +* NXP i.MX 8M Plus + + +## What is New in ghaf-24.09.1 + +* Lenovo X1 Carbon Gen 10/11: + * Audio Control and [Xarchiver](https://github.com/ib/xarchiver) file compression applications. + * Network Manager applet. + * The first version of the Control Panel (mainly non-functional). + * Log Out and Lock buttons were moved to the power menu. + * Shutdown and Reboot buttons were removed from the applications menu and are now available in the Power menu. + * Multiple monitors support. + + +## Bug Fixes + +Fixed bugs that were in the ghaf-24.09 release: + +* It is impossible to change the Wi-Fi network from the Network Settings application. +* The taskbar on extended display is visible only when booting up with HDMI connected. +* The Mute status is not visible in the taskbar. + + +## Known Issues and Limitations + +| Issue | Status | Comments | +|-----------------|-------------|--------------------------------------| +| The external USB camera is not working on Chromium VM | In Progress | A fix is in progress. | +| Cannot log in to the Element chat with a Google account | In Progress | Workaround: create a user specifically for Element. | +| Time synchronization between host and VMs does not work in all scenarios | In Progress | Under investigation. | +| Suspend does not work from the taskbar power menu | In Progress | Under investigation. | +| VPN credentials are not saved | On Hold | Not clear if this can be fixed. | +| The keyboard boots up with the English layout  | In Progress | Workaround: use Alt+Shift to switch between English-Arabic-Finnish layout. | +| Bluetooth notification windows stay on a screen  | In Progress | Workaround: use the Esc key to remove pop-up windows. | + + +## Environment Requirements + +There are no specific requirements for the environment with this release. + + +## Installation Instructions + +Released images are available at [ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-09-1](https://ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-09-1). + +Download the required image and use the following instructions: [Build and Run](../ref_impl/build_and_run). + diff --git a/docs/src/release_notes/ghaf-24.09.md b/docs/src/release_notes/ghaf-24.09.md new file mode 100644 index 000000000..7dd7875fa --- /dev/null +++ b/docs/src/release_notes/ghaf-24.09.md @@ -0,0 +1,94 @@ + + +# Release ghaf-24.09 + + +## Release Tag + + + + +## Supported Hardware + +The following target hardware is supported by this release: + +* NVIDIA Jetson AGX Orin +* NVIDIA Jetson Orin NX +* Generic x86 (PC) +* Polarfire Icicle Kit +* Lenovo ThinkPad X1 Carbon Gen 11 +* Lenovo ThinkPad X1 Carbon Gen 10 +* NXP i.MX 8M Plus + + +## What is New in ghaf-24.09 + +* Lenovo X1 Carbon Gen 10/11: + * Trusted Business VM with firewall protection containing the following applications: Microsoft 365 (with Outlook and Teams), Trusted Browser, Text Editor, Video Editor. + * Integrated camera supported with Business VM applications. + * The previous Element VM was modified to a more generic Comms VM, adding Slack.. + * GlobalProtect VPN client. + * Centralized logging solution using [Grafana](https://grafana.com/grafana/). + * The [ZFS](https://docs.oracle.com/cd/E19253-01/819-5461/zfsover-2/) file system and Logical Volume Manager (LVM). + * Storage VM using the [NixOS Impermanence](https://github.com/nix-community/impermanence) framework. + * USB hot plug supports input, audio, and media devices. + * USB camera support on Chromium VM. + * Initial version of file manager. + * Hardware detection scanner to generate hardware definition files for different laptops. + * GPU acceleration enabled. + * [YubiKey](https://www.yubico.com/products/) authentication. + * The [Falcon LLM](https://falconllm.tii.ae/falcon-models.html) AI model installed. + * The greetd login manager with the system automatic screen lock enabled locks screen after 5 minutes of inactivity. + * The UI [Waybar](https://github.com/Alexays/Waybar) was replaced by the [EWW (Elkowars Wacky Widgets)](https://github.com/elkowar/eww) taskbar. + * Magnification, Sticky Notes, Screenshot, Calculator applications. + * AppFlowy was disabled. +* NVIDIA Jetson Orin NX: + * JetPack baseline software updates and fixes. +* Further refactoring and modularization of the Ghaf framework. +* Development, testing, and performance tooling improvements. + + +## Bug Fixes + +Fixed bugs that were in the ghaf-24.06 release: + +N/A + + +## Known Issues and Limitations + +| Issue | Status | Comments | +|-----------------|-------------|--------------------------------------| +| **NVIDIA Jetson AGX Orin / Orin NX** | | | +| Cannot log in to the Element chat with a Google account | In Progress | Under investigation. | +| Screenshots cannot be taken successfully anymore | In Progress | Under investigation. | +| Orin AGX/NX and NUC: no taskbar visible | In Progress | Workaround: use the Windows key to open the menu. | +| Cannot connect to a hidden Wi-Fi network from GUI | In Progress | Workaround: connect with SSH to a netvm and run the command: `nmcli dev wifi connect SSID password PASSWORD hidden yes`. | +| Cannot make voice calls using the Element application | In Progress | Under investigation. | +| The Element application cannot find a camera | In Progress | Under investigation. | +| **Lenovo X1** | | | +| Cannot log in to the Element chat with a Google account | In Progress | Workaround: create a user specifically for Element. | +| Time synchronization between host and VMs does not work in all scenarios | In Progress | Under investigation. | +| It is impossible to change the Wi-Fi network from the Network Settings application | In Progress | A fix is under verification. Workaround: remove the current network from the application. | +| The taskbar on extended display is visible only when booting up with HDMI connected | In Progress | Under investigation. | +| Suspend does not work from the taskbar power menu | In Progress | Under investigation. | +| The Mute status is not visible in the taskbar | In Progress | A fix is in progress. | +| VPN credentials are not saved | On Hold | Not clear if this can be fixed. | +| The keyboard boots up with the English layout  | In Progress | Workaround: use Alt+Shift to switch between English-Arabic-Finnish layout. | +| Bluetooth notification windows stay on a screen  | In Progress | Workaround: use the Esc key to remove pop-up windows. | + + +## Environment Requirements + +There are no specific requirements for the environment with this release. + + +## Installation Instructions + +Released images are available at [ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-09](https://ghafreleasesstorage.z16.web.core.windows.net/ghaf-24-09). + +Download the required image and use the following instructions: [Build and Run](../ref_impl/build_and_run). + diff --git a/docs/src/release_notes/release_notes.md b/docs/src/release_notes/release_notes.md index 0d400d658..257a314a7 100644 --- a/docs/src/release_notes/release_notes.md +++ b/docs/src/release_notes/release_notes.md @@ -12,6 +12,8 @@ Release numbering scheme: *ghaf-yy.mm*. ## In This Chapter +- [Release ghaf-24.09.1](../release_notes/ghaf-24.09.1.md) +- [Release ghaf-24.09](../release_notes/ghaf-24.09.md) - [Release ghaf-24.06](../release_notes/ghaf-24.06.md) - [Release ghaf-24.03](../release_notes/ghaf-24.03.md) - [Release ghaf-23.12](../release_notes/ghaf-23.12.md) diff --git a/docs/src/troubleshooting/troubleshooting.md b/docs/src/troubleshooting/troubleshooting.md index b312987a4..cc99780d7 100644 --- a/docs/src/troubleshooting/troubleshooting.md +++ b/docs/src/troubleshooting/troubleshooting.md @@ -19,7 +19,7 @@ Since security is the utmost priority, every service has restricted access to re Our current troubleshooting scenarios are the following: -* [Analyzing system logs](./systemd/systemd-analyzer.md) +* [Analyzing system logs](./systemd/system-log.md) * [Debugging systemd using systemctl](./systemd/systemctl.md) * [Inspecting services with systemd-analyze](./systemd/systemd-analyzer.md) * [Using strace for debugging the initialization sequence](./systemd/strace.md)