From 65b32d27c791633c86a11c4b09ffa26c2f2d6d88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabian=20Sch=C3=B6ppach?= <163308053+fabianschoeppach@users.noreply.github.com> Date: Wed, 29 May 2024 09:19:55 +0200 Subject: [PATCH 1/5] Update template_README.md Include troubleshooting for when only the example schema is displayed, but not the self-created schema. --- template_README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/template_README.md b/template_README.md index d43d936..881a78f 100644 --- a/template_README.md +++ b/template_README.md @@ -136,3 +136,14 @@ be generated. You can read how to make your package public in the GitHub docs [here](https://docs.github.com/en/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility) or how to configure a PAT (if you want to keep the distribution private) in the GitHub docs [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic). + +--- + + *I included and extended a custom NOMAD plugin generated from the [official NOMAD plugin template](https://github.com/FAIRmat-NFDI/nomad-plugin-template), but I can only see/use the example schema and not my own I created.* + +This is probably a matter of incorrectly configured EntryPoints of your own schema. +First, make sure that the EntryPoint of the schema is mentioned in the `pyproject.toml` of the plugin. +Furthermore, it is necessary to generate a new Oasis distribution image after changes. Trigger this manually in Github under Action > Docker (left column) > Run workflow. + + + From d5c8b51d6349592c379988f1ff0eed916726d194 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabian=20Sch=C3=B6ppach?= <163308053+fabianschoeppach@users.noreply.github.com> Date: Wed, 29 May 2024 09:29:19 +0200 Subject: [PATCH 2/5] Update template_README.md Clarifying the section about updating the image --- template_README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/template_README.md b/template_README.md index 881a78f..9490459 100644 --- a/template_README.md +++ b/template_README.md @@ -58,11 +58,14 @@ curl localhost/nomad-oasis/alive ``` 8. Finally, open [http://localhost/nomad-oasis](http://localhost/nomad-oasis) in your browser to start using your new NOMAD Oasis. -Whenever you update your image you need to shut down NOMAD using +#### Updating the 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: ```sh docker compose down +docker compose pull +docker compose up -d ``` -and then repeat steps 5. and 6. above. #### NOMAD Remote Tools Hub (NORTH) To run NORTH (the NOMAD Remote Tools Hub), the `hub` container needs to run docker and From 1e821dc42e78254156adef5842c846c10a3f83a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabian=20Sch=C3=B6ppach?= <163308053+fabianschoeppach@users.noreply.github.com> Date: Wed, 29 May 2024 11:27:40 +0200 Subject: [PATCH 3/5] Update template_README.md Mention the `include` issue of the `nomad.yml`. --- template_README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/template_README.md b/template_README.md index 9490459..049af8e 100644 --- a/template_README.md +++ b/template_README.md @@ -145,8 +145,9 @@ be generated. *I included and extended a custom NOMAD plugin generated from the [official NOMAD plugin template](https://github.com/FAIRmat-NFDI/nomad-plugin-template), but I can only see/use the example schema and not my own I created.* This is probably a matter of incorrectly configured EntryPoints of your own schema. -First, make sure that the EntryPoint of the schema is mentioned in the `pyproject.toml` of the plugin. -Furthermore, it is necessary to generate a new Oasis distribution image after changes. Trigger this manually in Github under Action > Docker (left column) > Run workflow. +* First, make sure that the EntryPoint of the schema is mentioned in the `pyproject.toml` of the plugin. +* Furthermore, it is necessary to generate a new Oasis distribution image after changes. Trigger this manually in Github under Action > Docker (left column) > Run workflow. +* Finally, the new plugin mechanism is not compatible with the use of the `plugins/include` option in the `nomad.yml` configuration file. Omitting this section completely solves this issue, as it will load all installed/available plugins. From 1cad53c332936924ccceddad47b7992b421e46df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabian=20Sch=C3=B6ppach?= <163308053+fabianschoeppach@users.noreply.github.com> Date: Wed, 29 May 2024 13:06:54 +0200 Subject: [PATCH 4/5] Update template_README.md --- template_README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/template_README.md b/template_README.md index 049af8e..d53a8ae 100644 --- a/template_README.md +++ b/template_README.md @@ -147,7 +147,7 @@ be generated. This is probably a matter of incorrectly configured EntryPoints of your own schema. * First, make sure that the EntryPoint of the schema is mentioned in the `pyproject.toml` of the plugin. * Furthermore, it is necessary to generate a new Oasis distribution image after changes. Trigger this manually in Github under Action > Docker (left column) > Run workflow. -* Finally, the new plugin mechanism is not compatible with the use of the `plugins/include` option in the `nomad.yml` configuration file. Omitting this section completely solves this issue, as it will load all installed/available plugins. +* Finally, the new plugin mechanism is not compatible with the use of the `plugins/include` option in the `nomad.yml` configuration file. Omitting this section completely will solve this problem, as it will load all installed/available plugins. From 6181b895319aba698b813f7db44f0cb7e2ec05f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabian=20Sch=C3=B6ppach?= <163308053+fabianschoeppach@users.noreply.github.com> Date: Thu, 30 May 2024 09:23:21 +0200 Subject: [PATCH 5/5] Update template_README.md Mention plugin loading via entry points in `nomad.yaml`. --- template_README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/template_README.md b/template_README.md index d53a8ae..9d4764b 100644 --- a/template_README.md +++ b/template_README.md @@ -147,7 +147,7 @@ be generated. This is probably a matter of incorrectly configured EntryPoints of your own schema. * First, make sure that the EntryPoint of the schema is mentioned in the `pyproject.toml` of the plugin. * Furthermore, it is necessary to generate a new Oasis distribution image after changes. Trigger this manually in Github under Action > Docker (left column) > Run workflow. -* Finally, the new plugin mechanism is not compatible with the use of the `plugins/include` option in the `nomad.yml` configuration file. Omitting this section completely will solve this problem, as it will load all installed/available plugins. - +* Finally, the way to explicitly include or exclude plugins from loading using the `nomad.yaml` configuration file has changed in the past. The easiest way is to omit the `plugins/include` option in `nomad.yaml` altogether, as this will load all installed/available plugins. + To still control plugin loading explicitly via `nomad.yaml`, you have to use `plugins.entry_points.{include/exclude}` with the corresponding `entry-points` of the used schemas or parsers, as they are also listed in the `pyproject.toml` of the respective plugin. More details about it [here](https://nomad-lab.eu/prod/v1/staging/docs/howto/plugins/plugins.html#controlling-loading-of-plugin-entry-points).