Skip to content

Commit

Permalink
Update template_README.md with better deployement instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
hampusnasstrom authored Mar 18, 2024
1 parent d18f9a7 commit f3b6916
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions template_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,43 @@ Below are instructions for how to deploy this NOMAD Oasis distribution

### For a new Oasis

- Find a Linux computer.
- Make sure you have [docker](https://docs.docker.com/engine/install/) installed.
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/).
- Download the modified configuration files [nomad-oasis.zip](nomad-oasis.zip) from this repository.
- Run the following commands (skip `chown` on MacOS and Windows computers)


2. Get the `nomad-oasis.zip` archive from your distribution repository using for example curl
```sh
curl -L -o nomad-oasis.zip "https://github.com/GITHUB_REPOSITORY/raw/main/nomad-oasis.zip"
```
3. Unzip the `nomad-oasis.zip` file and enter the extracted directory
```sh
unzip nomad-oasis.zip
cd nomad-oasis
```
4. _On Linux only,_ recursively change the owner of the `.volumes` directory to the nomad user (1000)
```sh
sudo chown -R 1000 .volumes
```
5. Pull the images speicified in the `docker-compose.yaml` (retrieved from the `nomad-oasis.zip`) using
```sh
docker compose pull
```
6. And run it with docker compose in detached (--detach or -d) mode
```sh
docker compose up -d
```
7. Optionally you can now test that NOMAD is running with
```
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.

- Open [http://localhost/nomad-oasis](http://localhost/nomad-oasis) in your browser.
Whenever you update your image you need to shut down NOMAD using
```sh
docker compose down
```
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
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.
Expand All @@ -68,6 +86,8 @@ the inclusion of the `nomad.yaml` under the volumes key of those services in the
# - ./configs/nomad.yaml:/app/nomad.yaml
```

To run the new image you can follow steps 5. and 6. [above](#for-a-new-oasis).

## Adding a plugin

To add a new plugin to the docker image you should add it to the [plugins.txt](plugins.txt) file.
Expand Down

0 comments on commit f3b6916

Please sign in to comment.