Merge pull request #4 from edera-dev/bleggett/ux-twiddle

Rename to `edera-check`, CLI-ify, support running outside of a container, etc etc

Author: bleggett

.github/workflows/release-artifacts.yml

@@ -11,7 +11,7 @@ on:
   workflow_dispatch:
     inputs:
       protect_ref:
-        description: 'Edera Protect commit/branch/tag'
+        description: 'Edera commit/branch/tag'
         default: ''
 
   # Nightly build from HEAD
@@ -57,14 +57,14 @@ jobs:
       run: |
         echo "Since GitHub doesn't have a way to filter for specific tags in the release event we need to implement this dumb check"
         run=true
-        if [[ '${{ github.event_name }}' == 'release' ]] && [[ '${{ github.ref_name }}' =~ 'protect-chart-*' ]]; then
+        if [[ '${{ github.event_name }}' == 'release' ]] && [[ '${{ github.ref_name }}' =~ 'chart-*' ]]; then
           run=false
         fi
         echo "Workflow should run: ${run}"
         echo "should_run=${run}" >> ${GITHUB_OUTPUT}
 
   oci:
-    name: 'Build and publish protect-${{ matrix.component }} images'
+    name: 'Build and publish ${{ matrix.component }} images'
     # Check if this is the proper release event.
     # TODO: remove this when actions has a better answer
     if: ${{ needs.release-gate.outputs.should_run == 'true' }}
@@ -74,7 +74,7 @@ jobs:
       fail-fast: false
       matrix:
         component:
-        - preflight
+        - edera-check
     permissions:
       contents: read
       id-token: write
@@ -92,14 +92,14 @@ jobs:
         submodules: recursive
         persist-credentials: false
 
-    - name: 'Build and sign protect-${{ matrix.component }} image'
+    - name: 'Build and sign ${{ matrix.component }} image'
       uses: edera-dev/actions/build-and-sign-image@v0.0.6
       with:
         component: '${{ matrix.component }}'
         event: '${{ github.event_name }}'
         repositories: |
-          ghcr.io/edera-dev/protect-${{ matrix.component }}
-          ${{ env.GCP_REGION }}-docker.pkg.dev/${{ env.GCP_PROJECT }}/staging/protect-${{ matrix.component }}
+          ghcr.io/edera-dev/${{ matrix.component }}
+          ${{ env.GCP_REGION }}-docker.pkg.dev/${{ env.GCP_PROJECT }}/staging/${{ matrix.component }}
         gcp_region: '${{ env.GCP_REGION }}'
         gcp_workload_identity_provider: '${{ env.GCP_WORKLOAD_IDENTITY_PROVIDER }}'
         gcp_service_account: '${{ env.GCP_SERVICE_ACCOUNT }}'

.gitignore

@@ -32,4 +32,4 @@ cli.md
 
 # example outputs
 /image-cache
-protect-preflight-bundle*
+edera-preinstall-report*

Cargo.lock

@@ -1,8 +1,8 @@
 [package]
-name = "preflight"
-version = "0.1.0"
+name = "edera-check"
+version = "0.2.0"
 edition = "2024"
-description = "CLI to run pre-deployment checks before running workloads."
+description = "CLI to run checks before installing or using Edera"
 
 [dependencies]
 anyhow = "1.0.99"
@@ -19,3 +19,5 @@ tokio-stream = { version = "0.1", features = ["io-util", "net"] }
 nix = { version= "0.31", features = ["sched"] }
 futures = "0.3"
 async-trait = "0.1"
+clap = { version = "4.5", features = ["derive"] }
+console = "0.16"

Cargo.toml

@@ -1,26 +1,34 @@
-# Preflight CLI
+# edera-check CLI
 
-Internal CLI to run **pre-deployment checks** before running workloads.  
-Checks are organized into groups (e.g., `PVH Checks`, `Kernel Checks`) and controlled via environment variables.
+CLI tool to run checks and generate system reports before installing or using Edera.
 
 ---
 
 ## Usage
 
+### General usage
+
+```bash
+sudo edera-check --help
+```
+
+### Run preinstall checks and generate system report
+
+```bash
+sudo edera-check preinstall
+```
+
 ### Run official release via Docker
 
 ```bash
 docker run \
   --pull always \
-  --env RUST_LOG=debug \
-  --env EDERA_PREFLIGHT_VERBOSE=true \
-  --env EDERA_PREFLIGHT_SKIP_GROUPS='PVHChecks;KernelChecks' \
   --pid host \
   --privileged \
-  us-central1-docker.pkg.dev/edera-protect/staging/protect-preflight:main
+  us-central1-docker.pkg.dev/edera-protect/staging/edera-check:main preinstall
 ```
 
-Podman should also work.
+Podman et al should also work.
 
 ### Run locally from repo root via Docker
 
@@ -32,65 +40,49 @@ sh hack/debug/local.sh
 
 ---
 
-## Environment Variables
-
-| Variable                      | Description                                            | Example                       |
-| ----------------------------- | ------------------------------------------------------ | ----------------------------- |
-| `RUST_LOG`                    | Log level (`error`, `warn`, `info`, `debug`, `trace`). | `debug`                       |
-| `EDERA_PREFLIGHT_VERBOSE`     | Enable verbose output (`true`/`false`).                | `true`                        |
-| `EDERA_PREFLIGHT_SKIP_GROUPS` | Semicolon-separated list of groups to skip.            | `PVHChecks;KernelChecks` |
-| `EDERA_PREFLIGHT_REPORT_DIR` | Directory to write a report to. Defaults to tmpdir       | `/tmp`                    |
-
----
-
 ## Example Output
 
 ```text
-[2026-02-13T00:28:35Z INFO  preflight] Writing all files to /tmp/protect-preflight-bundle-20260213-002835
-[2026-02-13T00:28:35Z INFO  preflight] Running Group [System Checks] - System requirement checks
-[2026-02-13T00:28:35Z DEBUG preflight::checkers::system] Enough space on disk mounted at / - 617760940032
-[2026-02-13T00:28:35Z DEBUG preflight::checkers::system] Not enough space on disk mounted at /etc/resolv.conf - 9729925120
-[2026-02-13T00:28:35Z DEBUG preflight::checkers::system] Enough space on disk mounted at /etc/hostname - 617760940032
-[2026-02-13T00:28:35Z DEBUG preflight::checkers::system] Enough space on disk mounted at /etc/hosts - 617760940032[2026-02-13T00:28:35Z DEBUG preflight::checkers::system] total memory = 28762972160
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [System Checks] Passed
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [System Checks] Enough Memory: Passed
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [System Checks] Enough Disk: Passed
-[2026-02-13T00:28:35Z INFO  preflight] Running Group [PVH Checks] - PVH capability checks
-[2026-02-13T00:28:35Z DEBUG preflight::checkers::pvh] VM_CR=0x0 (svmdis=0)
-[2026-02-13T00:28:35Z DEBUG preflight::checkers::pvh] EFER=0x200d01 (SVME=0)
-[2026-02-13T00:28:35Z DEBUG preflight::checkers::pvh] AMD-V supported but unavailable under hypervisor
-[2026-02-13T00:28:35Z DEBUG preflight::checkers::pvh] Virtualization is enabled or can be enabled
-[2026-02-13T00:28:35Z DEBUG preflight::helpers] [PVH Checks] Skipped
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [PVH Checks] PVH Support: Passed
-[2026-02-13T00:28:35Z INFO  preflight] Running Group [Kernel Checks] - Kernel requirement checks
-[2026-02-13T00:28:35Z DEBUG preflight::checkers::kernel] module msr
-[2026-02-13T00:28:35Z DEBUG preflight::checkers::kernel] module nf_tables
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [Kernel Checks] Passed
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [Kernel Checks] Host Has Necessary Modules: Passed
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [Kernel Checks] Host Kernel Version Is Good: Passed
-[2026-02-13T00:28:35Z INFO  preflight] Running Group [System Info Recorder] - System requirement and status checks - records for informational purposes
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [System Info Recorder] Passed
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [System Info Recorder] Record lspci -vvv: Passed
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [System Info Recorder] Record dmidecode: Passed
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [System Info Recorder] Record /proc/cpuinfo: Passed
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [System Info Recorder] Record /proc/cmdline: Passed
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [System Info Recorder] Record /boot/grub2/grub.cfg: Passed
-[2026-02-13T00:28:35Z INFO  preflight::helpers] [System Info Recorder] Record boot/config-6.18.6: Passed
-[2026-02-13T00:28:35Z DEBUG preflight] Read 84023 bytes of tar
-[2026-02-13T00:28:35Z INFO  preflight] Wrote to: /tmp/protect-preflight-bundle-20260213-002835.tar.gz
+» sudo edera-check preinstall
+
+Running Group System Checks - System requirement checks
+✅ System Checks: Passed
+    • Enough Memory: Passed
+    • Enough Disk: Passed
+Running Group PVH Checks - PVH capability checks
+✅ PVH Checks: Passed
+    • PVH Support: Passed
+Running Group Kernel Checks - Kernel requirement checks
+✅ Kernel Checks: Passed
+    • Host Has Necessary Modules: Passed
+    • Host Kernel Version Is Good: Passed
+Running Group IOMMU Checks - IOMMU capability checks
+✅ IOMMU Checks: Passed
+    • IOMMU Support: Passed
+Running Group System Info Recorder - Record system information for reporting purposes
+✅ System Info Recorder: Passed
+    • Record lspci -vvv: Passed
+    • Record dmidecode: Passed
+    • Record /proc/cpuinfo: Passed
+    • Record /proc/cmdline: Passed
+    • Record /boot/grub2/grub.cfg: Passed
+    • Record boot/config-6.18.7-200.fc43.x86_64: Passed
+✨ All Done! Report saved: /tmp/edera-preinstall-report-StolidWingnut-20260213-222635.tar.gz
 ```
 
-* **INFO** → check passed or group started
-* **WARN** → check failed
-* **ERROR** → check errored or group errored
-
 Exit code is **non-zero** if any check/group fails or errors.
 
 ---
 
 ## Notes
 
-* Use `EDERA_PREFLIGHT_SKIP_GROUPS` to bypass slow or irrelevant checks.
+Run
+
+``` bash
+edera-check preinstall --help
+```
+
+for a list of available configuration options and usage tweaks.
 
 ## Dev Notes
 

README.md

@@ -5,12 +5,9 @@ VER=$(date +%s)
 USERIMG=$(whoami)
 REGISTRY="localhost"
 
-docker build . -f ./images/Containerfile.preflight -t "${REGISTRY}/${USERIMG}-preflight-debug:${VER}"
+docker build . -f ./images/Containerfile.edera-check -t "${REGISTRY}/${USERIMG}-edera-check-debug:${VER}"
 
 docker run --privileged --pid="host" \
   -e RUST_LOG="debug" \
   -e EDERA_PREFLIGHT_VERBOSE=true \
-  -e EDERA_PREFLIGHT_TARGET_DIR='/host' \
-  -e EDERA_PREFLIGHT_SKIP_GROUPS='' \
-  -e EDERA_PREFLIGHT_SCRIPTS_DIR=/scripts \
-  "${REGISTRY}/${USERIMG}-preflight-debug:${VER}"
+  "${REGISTRY}/${USERIMG}-edera-check-debug:${VER}" preinstall