From e5d7458a8ba9192b147f0ad859254c2476647d88 Mon Sep 17 00:00:00 2001 From: Jenni Nikolaenko Date: Tue, 9 Jan 2024 17:56:21 +0200 Subject: [PATCH] Docs: minor changes Signed-off-by: Jenni Nikolaenko --- docs/src/SUMMARY.md | 8 ++--- docs/src/appendices/glossary.md | 4 +++ docs/src/features/features.md | 34 +++++++++++-------- .../{ghaf-23.05.23.md => ghaf-23.05.md} | 0 .../{ghaf-23.06.23.md => ghaf-23.06.md} | 0 .../{ghaf-23.09.23.md => ghaf-23.09.md} | 0 .../{ghaf-23.12.23.md => ghaf-23.12.md} | 2 +- docs/src/release_notes/release_notes.md | 11 +++--- docs/src/research/research.md | 2 +- 9 files changed, 35 insertions(+), 26 deletions(-) rename docs/src/release_notes/{ghaf-23.05.23.md => ghaf-23.05.md} (100%) rename docs/src/release_notes/{ghaf-23.06.23.md => ghaf-23.06.md} (100%) rename docs/src/release_notes/{ghaf-23.09.23.md => ghaf-23.09.md} (100%) rename docs/src/release_notes/{ghaf-23.12.23.md => ghaf-23.12.md} (97%) diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 659feab43..8045dc629 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -52,10 +52,10 @@ - [Public Key Infrastructure](scs/pki.md) - [Security Fix Automation](scs/ghaf-security-fix-automation.md) - [Release Notes](release_notes/release_notes.md) - - [Release ghaf-23.12](release_notes/ghaf-23.12.23.md) - - [Release ghaf-23.09](release_notes/ghaf-23.09.23.md) - - [Release ghaf-23.06](release_notes/ghaf-23.06.23.md) - - [Release ghaf-23.05](release_notes/ghaf-23.05.23.md) + - [Release ghaf-23.12](release_notes/ghaf-23.12.md) + - [Release ghaf-23.09](release_notes/ghaf-23.09.md) + - [Release ghaf-23.06](release_notes/ghaf-23.06.md) + - [Release ghaf-23.05](release_notes/ghaf-23.05.md) # Ghaf Usage Scenarios diff --git a/docs/src/appendices/glossary.md b/docs/src/appendices/glossary.md index e6d92252e..edf3ca1c4 100644 --- a/docs/src/appendices/glossary.md +++ b/docs/src/appendices/glossary.md @@ -94,6 +94,10 @@ _embedded MultiMediaCard_ _end-user license agreement_ +### GALA + +_The Google Android Look Alike application. Mobile client application for connecting to a Cloud Android device in Secured Google Cloud Platform VMs. Users see a remotely rendered Android phone desktop on their own device screen and interact with the Cloud Android device like the real mobile device. All application processing runs in the cloud._ + ### GUI _graphical user interface_ diff --git a/docs/src/features/features.md b/docs/src/features/features.md index 2ef1cd1c0..a22924b73 100644 --- a/docs/src/features/features.md +++ b/docs/src/features/features.md @@ -9,23 +9,27 @@ The vision for the Ghaf platform is to create a virtualized, scalable reference Ghaf demo desktop and applications are illustrated in the screen capture below: ![Ghaf demo desktop and application](../img/ghaf_demo_desktop.png) + + ## Status -* ✅ - integrated and tested in the `main` branch. No known regression. -* 🚧 - prototyped or work in progress in the development branch. -* ❌ - the feature has known regression or bugs. +* ✅—integrated and tested in the `main` branch. No known regression. +* 🚧—prototyped or work in progress in the development branch. +* ❌—the feature has known regression or bugs. + ### Reference Devices - `Orin`—NVIDIA Jetson AGX Orin as the main reference device. - `x86`—generic x86_64; tested on Intel NUC (Next Unit of Computing) or laptop. -- `Lenovo X1`—Lenovo X1 Carbon Gen11 laptop. -- `aarch64`—generic AArch64; tested on an ARM server, laptop (e.g. Apple M's), or NVIDIA Jetson AGX Orin. +- `Lenovo X1`—Lenovo X1 Carbon Gen 11 laptop. +- `aarch64`—generic AArch64; tested on an ARM server, laptop (e.g. Apple MacBook's), or NVIDIA Jetson AGX Orin. - `All variants`—supported devices from [Architectural Variants](https://tiiuae.github.io/ghaf/architecture/variants.html). The following tables show the status of Ghaf Platform features: -## Release builds and HW architecture support + +## Release Builds and Hardware Architecture Support | Feature | Status | Reference Device | Details | |-------------------|-------------|------------------|-------------------------------------| @@ -51,15 +55,16 @@ The following tables show the status of Ghaf Platform features: | Debug: Serial | ✅ | `all` | Host access only in `-debug`-target - e.g. `screen /dev/ttyACM0 115200` | | Compartmentalized environment | 🚧 | `Lenovo X1` | NetVM, GUI VM (with GPU passthrough) plus some Application VMs | -## Target architecture + +## Target Architecture | Feature | Status | Reference Device | Details | |-------------------|-------------|------------------|----------------------------------------------| | `minimal host` | 🚧 | [`all`](https://tiiuae.github.io/ghaf/architecture/variants.html) | See [Minimal Host](https://tiiuae.github.io/ghaf/architecture/adr/minimal-host.html) and [PR #140](https://github.com/tiiuae/ghaf/pull/140). | | `netvm` | ✅ | `Orin` | See [netvm](https://tiiuae.github.io/ghaf/architecture/adr/netvm.html). Passthrough with Wifi works but requires SSID/password configuration | | `idsvm` | ✅ | `Orin` | [Defensive security VM placeholder PR open](https://github.com/tiiuae/ghaf/pull/146) | -| `guivm` | 🚧 | `All`, `Lenovo-X1`| Implemented for Lenovo X1 reference device, other devices have Wayland compositor running on the host.| -| `appvm` | 🚧 | `All`, `Lenovo-X1`| Implemented for Lenovo X1 reference device: chromium, GALA and zathura VMs. Requires `guivm` in place | +| `guivm` | 🚧 | `All`, `Lenovo X1`| Implemented for Lenovo X1 reference device, other devices have Wayland compositor running on the host.| +| `appvm` | 🚧 | `All`, `Lenovo X1`| Implemented for Lenovo X1 reference device: chromium, GALA and zathura VMs. Requires `guivm` in place | | `adminvm` | ✅ | `All` | Not started | | Inter VM comms - IP-based | 🚧 | `All` |`-debug`-targets have network bridges to access VMs from host | | Inter VM comms - shared memory | 🚧 | `All` | | @@ -70,17 +75,18 @@ The following tables show the status of Ghaf Platform features: | UART passthrough | 🚧 | `Orin` | See [NVIDIA Jetson AGX Orin: UART Passthrough](https://tiiuae.github.io/ghaf/build_config/passthrough/nvidia_agx_pt_uart.html). Not integrated to any VM. | | ARM platform bus devices passthrough | 🚧 | `Orin` | NVIDIA BPMP virtualization being developed | -## Applications and VM control + +## Applications and VM Control | Feature | Status | Reference Device | Details | |-------------------|-------------|------------------|----------------------------------------------| -| Wayland-compositor | 🚧 | `Orin`, `x86` | Implemented for `Lenovo-X1` | -| Chromium | 🚧 | `Orin`, `x86` | Implemented for `Lenovo-X1` | +| Wayland-compositor | 🚧 | `Orin`, `x86` | Implemented for `Lenovo X1` | +| Chromium | 🚧 | `Orin`, `x86` | Implemented for `Lenovo X1` | | Element | 🚧 | `Orin`, `x86` | On host | -| Cloud Android (CVD) client app (GALA )| 🚧 | `Orin`, `x86` | Implemented for `Lenovo-X1` | +| Cloud Android (CVD) client application (GALA)| 🚧 | `Orin`, `x86` | Implemented for `Lenovo X1` | | Virtualization control | 🚧 | [`All`](https://tiiuae.github.io/ghaf/architecture/variants.html) | See [vmd design](https://github.com/tiiuae/vmd/blob/main/doc/design.md). | -## Next steps +## Next Steps [See discussion for the outline of next steps](https://github.com/tiiuae/ghaf/issues/150#issuecomment-1564061850) diff --git a/docs/src/release_notes/ghaf-23.05.23.md b/docs/src/release_notes/ghaf-23.05.md similarity index 100% rename from docs/src/release_notes/ghaf-23.05.23.md rename to docs/src/release_notes/ghaf-23.05.md diff --git a/docs/src/release_notes/ghaf-23.06.23.md b/docs/src/release_notes/ghaf-23.06.md similarity index 100% rename from docs/src/release_notes/ghaf-23.06.23.md rename to docs/src/release_notes/ghaf-23.06.md diff --git a/docs/src/release_notes/ghaf-23.09.23.md b/docs/src/release_notes/ghaf-23.09.md similarity index 100% rename from docs/src/release_notes/ghaf-23.09.23.md rename to docs/src/release_notes/ghaf-23.09.md diff --git a/docs/src/release_notes/ghaf-23.12.23.md b/docs/src/release_notes/ghaf-23.12.md similarity index 97% rename from docs/src/release_notes/ghaf-23.12.23.md rename to docs/src/release_notes/ghaf-23.12.md index b09f8132f..6fb3f2fb6 100644 --- a/docs/src/release_notes/ghaf-23.12.23.md +++ b/docs/src/release_notes/ghaf-23.12.md @@ -89,4 +89,4 @@ Download the required image and use the following instructions: | ghaf-23.12_Nvidia_Orin_NX_cross-compiled-no-demoapps[^note].tar.xz, ghaf-23.12_Nvidia_Orin_NX_cross-compiled.tar.xz, ghaf-23.12_Nvidia_Orin_NX_native-build.tar.xz | [Ghaf Image for NVIDIA Jetson Orin AGX](../ref_impl/build_and_run.md#ghaf-image-for-nvidia-jetson-orin-agx) | | ghaf-23.12_PolarFire_RISC-V.tar.xz | [Building Ghaf Image for Microchip Icicle Kit](../ref_impl/build_and_run.md#building-ghaf-image-for-microchip-icicle-kit) | -[^note] no-demoapps images do not include Chromium, Zathura, GALA (Google Android Look Alike) applications. \ No newline at end of file +[^note] no-demoapps images do not include Chromium, Zathura, and GALA applications. \ No newline at end of file diff --git a/docs/src/release_notes/release_notes.md b/docs/src/release_notes/release_notes.md index b044e4b41..5bbd39969 100644 --- a/docs/src/release_notes/release_notes.md +++ b/docs/src/release_notes/release_notes.md @@ -7,13 +7,12 @@ Ghaf is released 4 times per year at the end of each quarter. Additional releases may be made as per request. -Release numbering scheme: *ghaf-dd.mm*. +Release numbering scheme: *ghaf-yy.mm*. ## In This Chapter -- 2023 - - [Release ghaf-23.12](../release_notes/ghaf-23.12.23.md) - - [Release ghaf-23.09](../release_notes/ghaf-23.09.23.md) - - [Release ghaf-23.06](../release_notes/ghaf-23.06.23.md) - - [Release ghaf-23.05](../release_notes/ghaf-23.05.23.md) \ No newline at end of file +- [Release ghaf-23.12](../release_notes/ghaf-23.12.md) +- [Release ghaf-23.09](../release_notes/ghaf-23.09.md) +- [Release ghaf-23.06](../release_notes/ghaf-23.06.md) +- [Release ghaf-23.05](../release_notes/ghaf-23.05.md) \ No newline at end of file diff --git a/docs/src/research/research.md b/docs/src/research/research.md index 53c2f9e0d..96b70f754 100644 --- a/docs/src/research/research.md +++ b/docs/src/research/research.md @@ -8,4 +8,4 @@ Our experience in research, studies and lessons learned activities: * [i.MX 8QM platform bus ethernet passthrough](passthrough/ethernet.md) -* [System installation](research/installation.md) +* [System installation](installation.md)