This is an distribution image of a NOMAD Oasis provided by FAIRmat. Below are instructions on how to deploy this distribution and how to customize it by adding plugins.
Below are instructions on how to deploy this NOMAD Oasis distribution either for a new Oasis or for an existing Oasis. For further questions, consult the documentation.
- Make sure you have docker installed.
Docker nowadays comes with
docker compose
built in. Prior, you needed to install the stand-alone docker-compose. - Get the
nomad-oasis.zip
archive from this distribution repository. An easy option is using for example curl
curl -L -o nomad-oasis.zip "https://github.com/fabianschoeppach/nomad-UIBK-image/raw/main/nomad-oasis.zip"
- Unzip the
nomad-oasis.zip
file and enter the extracted directory
unzip nomad-oasis.zip
cd nomad-oasis
- On Linux only, recursively change the owner of the
.volumes
directory to the nomad user (1000)
sudo chown -R 1000 .volumes
- Pull the images specified in the
docker-compose.yaml
.
docker compose pull
- And run it with docker compose in detached (--detach or -d) mode
docker compose up -d
- Optionally you can now test that NOMAD is running with
curl localhost/nomad-oasis/alive
- Finally, open http://localhost/nomad-oasis in your browser to start using your new NOMAD Oasis.
Whenever you want to update your image you first need to shut down NOMAD using docker compose down
. Afterwards you can pull the updates and simply restart the oasis:
docker compose down
docker compose pull
docker compose up -d
To run NORTH (the NOMAD Remote Tools Hub), the hub
container needs to run docker and
the container has to be run under the docker group. You need to replace the default group
id 991
in the docker-compose.yaml
's hub
section with your systems docker group id.
Run id
if you are a docker user, or getent group | grep docker
to find your
systems docker gid. The user id 1000 is used as the nomad user inside all containers.
You can find more details on setting up and maintaining an Oasis in the NOMAD docs here: nomad-lab.eu/prod/v1/docs/oasis/install.html
If you already have an Oasis running you only need to change the image being pulled in
your docker-compose.yaml
with ghcr.io/fabianschoeppach/nomad-UIBK-image:main
for the services
worker
, app
, north
, and logtransfer
.
If you want to use the nomad.yaml
from this repository you also need to comment out
the inclusion of the nomad.yaml
under the volumes key of those services in the
docker-compose.yaml
.
volumes:
# - ./configs/nomad.yaml:/app/nomad.yaml
To run the new image you can follow steps 5. and 6. above.
To add a new plugin to the docker image you should add it to the plugins.txt file.
Here you can put either plugins distributed to PyPI, e.g.
nomad-material-processing
or plugins in a git repository with either the commit hash
git+https://github.com/FAIRmat-NFDI/nomad-measurements.git@71b7e8c9bb376ce9e8610aba9a20be0b5bce6775
or with a tag
git+https://github.com/FAIRmat-NFDI/nomad-measurements.git@v0.0.4
To add a plugin in a subdirectory of a git repository you can use the subdirectory
option, e.g.
git+https://github.com/FAIRmat-NFDI/AreaA-data_modeling_and_schemas.git@30fc90843428d1b36a1d222874803abae8b1cb42#subdirectory=PVD/PLD/jeremy_ikz/ikz_pld_plugin
If the plugin is new, you also need to add it under plugins
in the nomad.yaml
config file that will be included in the image.
For example, if you have added a schema plugin nomad_material_processing
you should add
the following:
plugins:
options:
schemas/nomad_material_processing:
python_package: nomad_material_processing
Once the changes have been committed to the main branch, the new image will automatically be generated.
I get an Error response from daemon: Head "https://ghcr.io/v2/fabianschoeppach/nomad-UIBK-image/manifests/main": unauthorized
when trying to pull my docker image.
Most likely you have not made the package public or provided a personal access token (PAT). You can read how to make your package public in the GitHub docs here or how to configure a PAT (if you want to keep the distribution private) in the GitHub docs here.