phylum-dev / cli

Command line interface for the Phylum API
https://phylum.io
GNU General Public License v3.0
101 stars 10 forks source link

Provide more information on system minimum requirements #1350

Closed maxrake closed 6 months ago

maxrake commented 6 months ago

Overview

User feedback has shown that there are times when system minimum requirements are not met and actions like lockfile generation failed, but with less than helpful output such that the source of the problem and possible corrective actions were not provided. Here is one example of such output:

---TRIMMED---
Caused by:
    0: Lockfile generation failed! For details, see: https://docs.phylum.io/docs/lockfile_generation
    1: subprocess failed:
       ❗ Error: input/output error: Function not implemented (os error 38)

In this case, the Error message was confusing and the provided link did not yield any more detail to resolve the error. It turned out to be the case that the system kernel version was too old to support one of the required/requested sandbox permissions, but that was only uncovered by developers of the tool after reaching out for their support. The user had no clue what was wrong or what they could do themselves to figure that out.

This issue is meant to help users in as many ways as possible. Actions which may help include, but are not limited to:

Acceptance Criteria