docs: add build and test docs for all mayastor repos

[tiagolobocastro]

No description provided.

[maxwnewcomer]

Thank you so much for putting this together, cleared up a lot of questions I've had.

[tiagolobocastro]

Thank you so much for putting this together, cleared up a lot of questions I've had.

Thanks @maxwnewcomer, I'm glad this helps!
Let us know if there's anything else we could improve on

Something that could be interesting is how to cross-compile for ARM from x86.
The kubectl-mayastor plugin is currently cross-compiled for ARM.
It does take an awful lot of time though: https://github.com/openebs/mayastor-extensions/actions/runs/12351790197/job/34467462887
Though I'm not sure why, I suspect caching may not be working quite correctly on the github actions.

[dsharma-dc]

We can mention here that port forwarding may be required to use swagger UI.

[tiagolobocastro]

Are you thinking of K8s?

[dsharma-dc]

I guess it depends where deployer is started. e.g typically if started in a VM that we ssh into, then have to port forward between local machine and VM. e.g
ssh -L 8081:127.0.0.1:8081 username@host

[tiagolobocastro]

If someone is starting it on a remote shell, then they should know they have to port-forward that, it won't magically appear on their hosts :)

[dsharma-dc]

we recommend minimum 1024 2MiB hugepages typically

[tiagolobocastro]

Existing docs mentions 512, so guess we should change it

[dsharma-dc]

Existing docs mentions 512, so guess we should change it

Here we say 1024: https://openebs.io/docs/4.0.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/rs-installation#preparing-the-cluster

[tiagolobocastro]

mayastor/doc/test.md

Line 8 in 17488f4

- Ensure at least 512 2MB hugepages.

[tiagolobocastro]

hmm I wonder if actually neither is sufficient, some tests use a lot of IO engines and run IO.
Perhaps we ought to run the tests with 1024 and check if it's enough.

[tiagolobocastro]

Alright, looks like for testing you actually need 3584 for the rust tests and 2560 for the bdd tests.