search

nanovms / ops-documentation

Documentation for NanoVMs OPS
https://docs.ops.city
20 stars 37 forks source link

could use better documentation on how to properly debug acceleration #38

Open eyberg opened 5 years ago

ExternalReality commented 5 years ago

Does mean add a detailed description akin to:

1) Check to see if your system supports Accel 2) Check to see if the modules are loaded on linux 3) Check to see if you are part of the kvm group on linux 4) Try running hello world example with accel enabled

Is that the kind of debugging we are talking about? To help users get accel working? Or are we talking abut something more low level?

Note that on MacOS accel doesn't really need much documentation. If you are using a version of MacOS that has hv_support and you are using a version of qemu that has hv_support then you are good if you added the accel flag to your config. Most modern Macs fall into this category.

ExternalReality commented 5 years ago

A command ops accel-check could be implemented rather easily. The command would provide some debug info:

Your system does not support hardware acceleration Your system support hardware acceleration but no hypervisors found. Supported hypervisors are ... Your user <username> is not part of the kvm group. Please add your user to the kvm group ...

eyberg commented 5 years ago

nah - I was just thinking of a help section for docs listing some of the checks you mentioned - eg: are you in a vm already, do you have rights to kvm, etc.. but if you want to roll an accel-check I'm not opposed to that either - I'm already thinking of ways to automate help/debugging

ExternalReality commented 5 years ago

https://github.com/nanovms/ops-documentation/pull/42