generated from FAIRmat-NFDI/nomad-plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update to the "install this plugin page" * gif instructions for install plugin * Changed minor things in docs. --------- Co-authored-by: Ahmed Mansour <[email protected]> Co-authored-by: Pepe Marquez <[email protected]>
- Loading branch information
1 parent
73cee00
commit c4ee244
Showing
8 changed files
with
93 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,83 @@ | ||
# Install This Plugin | ||
# Deploying a NOMAD Oasis with the UniSysCat Plugin | ||
|
||
To install this plugin follow [part 4 of the FAIRmat tutorial 13](https://github.com/FAIRmat-NFDI/AreaA-Examples/tree/main/tutorial13/part4) or read the [NOMAD plugin documentation](https://nomad-lab.eu/prod/v1/staging/docs/plugins/plugins.html#add-a-plugin-to-your-nomad) for all details on how to deploy the plugin on your NOMAD Oasis instance. | ||
## Prerequisites | ||
- A GitHub account, which can be created for free on [github.com](https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home). | ||
- Docker installed on your computer; installation instructions can be found on [docs.docker.com/desktop/](https://docs.docker.com/desktop/). | ||
- The following instructions are for the Windows operating system. If you are using Linux, please refer to the detailed instructions [here](https://github.com/FAIRmat-NFDI/AreaA-Examples/tree/main/tutorial13/part4) or read the [NOMAD plugin documentation](https://nomad-lab.eu/prod/v1/staging/docs/howto/oasis/plugins_install.html) for all details on how to deploy the plugin on your NOMAD instance. | ||
|
||
To install this plugin, follow [part 4 of the FAIRmat tutorial 13](https://github.com/FAIRmat-NFDI/AreaA-Examples/tree/main/tutorial13/part4) or read the [NOMAD plugin documentation](https://nomad-lab.eu/prod/v1/staging/docs/plugins/plugins.html#add-a-plugin-to-your-nomad) for all details on how to deploy the plugin on your NOMAD Oasis instance. | ||
|
||
If you already have a NOMAD Oasis, you just need to add the line | ||
## Outline | ||
1. Create a Docker image | ||
2. Add the plugin | ||
3. Update permissions | ||
4. Run the OASIS | ||
|
||
## 1. Create a Docker image | ||
We will now create a custom Docker image for your OASIS. There is a GitHub template repository with predefined workflows that can be used for this at [github.com/FAIRmat-NFDI/nomad-distribution-template](https://github.com/FAIRmat-NFDI/nomad-distribution-template). | ||
|
||
To use the template, choose the "Create a new repository" option after pressing the green "Use this template" button in the upper right corner. Please note that you have to be logged into GitHub to see this option. | ||
|
||
![gif for creating an Oasis deployment on GitHub](../images/Deploying%20Oasis%20with%20plugin.gif) | ||
|
||
## 2. Add the plugin | ||
We will now add the plugin we developed as a demonstration for UniSysCat. To do this, we need to add the following line to the `plugins.txt` file: | ||
|
||
``` | ||
git+https://github.com/FAIRmat-NFDI/nomad-unisyscat-plugin.git@main | ||
``` | ||
|
||
We can do this directly from the GitHub web UI. Once this is saved, a workflow will run to create the image. | ||
|
||
![gif for adding the plugin to NOMAD Oasis deployment](../images/Deploying%20Oasis%20with%20plugin%202.gif) | ||
|
||
## 3. Update permissions | ||
1. Make sure you have [Docker](https://docs.docker.com/engine/install/) installed. Docker nowadays comes with `docker compose` built in. Prior, you needed to install the stand-alone [docker-compose](https://docs.docker.com/compose/install/). | ||
2. Download the `nomad-oasis.zip` archive from your distribution repository to your computer. | ||
3. Unzip the `nomad-oasis.zip` file. | ||
|
||
![gif for downloading and unzipping the Oasis file](../images/Deploying%20Oasis%20with%20plugin%203.gif) | ||
|
||
4. Open Docker Desktop. | ||
5. Open the Windows command prompt and set the directory to the location where you have unzipped the nomad-oasis file. Below is an example for navigating to the directory where we saved the file. Make sure to change this to the directory you specified. | ||
|
||
```sh | ||
cd C:\Users\Fair-04\Documents\UniSysCat demo\nomad-oasis\nomad-oasis | ||
``` | ||
|
||
6. Pull the images specified in the `docker-compose.yaml` (retrieved from the `nomad-oasis.zip`). Note that the image needs to be public or you need to provide a PAT. | ||
|
||
```sh | ||
docker compose pull | ||
``` | ||
|
||
7. Run it with Docker Compose in detached (`--detach` or `-d`) mode. | ||
|
||
```sh | ||
docker compose up -d | ||
``` | ||
|
||
8. Optionally, you can now test that NOMAD is running with: | ||
|
||
```sh | ||
curl localhost/nomad-oasis/alive | ||
``` | ||
|
||
![gif for pulling and decomposing the Oasis with Docker](../images/Deploying%20Oasis%20with%20plugin%204.gif) | ||
|
||
9. Finally, open [NOMAD Oasis](http://localhost/nomad-oasis) in your browser to start using your new NOMAD Oasis. | ||
|
||
```sh | ||
http://localhost/nomad-oasis | ||
``` | ||
|
||
![gif for accessing NOMAD Oasis locally](../images/Deploying%20Oasis%20with%20plugin%205.gif) | ||
|
||
## Additional Instructions | ||
If you already have a NOMAD Oasis, you just need to add the line: | ||
|
||
```sh | ||
git+https://github.com/FAIRmat-NFDI/nomad-unisyscat-plugin.git@main | ||
``` | ||
to the plugin.txt in your NOMAD Oasis repositorium. | ||
|
||
to the `plugin.txt` in your NOMAD Oasis repository. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters