search

NERSC / podman-hpc

Other
38 stars 10 forks source link

Improve installation documentation #84

Open scanon opened 1 year ago

scanon commented 1 year ago

Add more details to the documentation about dependencies and configuration.

scanon commented 1 year ago

For example explain how to build the static mksquashfs.

bryanherman commented 1 year ago

I didn't see the Dockerfile page in the repo until after I went through some of the pain of building deps, but here is what I suggest.

Have an INSTALL.md that states upfront what the main dependencies are:

You could give suggestions for each, like using your OS's package repository. For squashfs-tools you can point them to your Dockerfile. I will post below how I built it from scratch. Or I can take a stab at it if you agree to the layout.

bryanherman commented 1 year ago

Steps I used to build static mksquashfs manually (RHEL8 flavor):

Note that the static executables will be in the folder $PWD/here.

bryanherman commented 1 year ago

Also I would like to mention that we are creating a Spack package for Podman-HPC and getting all the deps building correctly from source. So this will help with shared deployments on a system. Also, it's a good traceable way to see how everything was build. I'm folding in the commits to Spack in individual PRs, but you can see an aggregate of all the changes if you look at the last few commits at: https://github.com/NavalNuclearLab/spack/tree/py-podman-hpc-all. If you like this approach we could add this to the installation docs as well. You also have the option of building Podman HPC against the system podman and deps with this (Spack externals).

lastephey commented 1 year ago

Hi @bryanherman

Thanks for sharing this info and apologies for our slow reply.

The INSTALL.md structure you proposed seems good to me. Your contribution is very welcome, but otherwise I can work on getting this implemented.

Thanks for the link to your Spack package. Your approach seems reasonable to me. If you think it's ready to share, we can also add a mention of this in our docs here.

scanon commented 1 year ago

I may split this out a bit. I think it would be useful to have docs on how to install via pip for a regular user and then have more detailed docs for a site installation.