From d18f9a78afe02c05473853ddc33c1af57cfb4393 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hampus=20N=C3=A4sstr=C3=B6m?= Date: Mon, 18 Mar 2024 15:46:35 +0100 Subject: [PATCH] Removed deploy instructions from README.md --- README.md | 50 -------------------------------------------------- 1 file changed, 50 deletions(-) diff --git a/README.md b/README.md index c699945..20074c4 100644 --- a/README.md +++ b/README.md @@ -9,53 +9,3 @@ This repository is a template for creating your own custom NOMAD Oasis distribut Click [here](https://github.com/new?template_name=nomad-distribution-template&template_owner=FAIRmat-NFDI) to use this template, or click the `Use this template` button in the upper right corner of the main GitHub page for this template. - -## Deploying the distribution - -Below are instructions for how to deploy this NOMAD Oasis distribution -[for a new Oasis](#for-a-new-oasis) and [for an existing Oasis](#for-an-existing-oasis) - -### For a new Oasis - -- Find a Linux computer. -- 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) - - -```sh -unzip nomad-oasis.zip -cd nomad-oasis -sudo chown -R 1000 .volumes -docker compose pull -docker compose up -d -curl localhost/nomad-oasis/alive -``` - -- Open [http://localhost/nomad-oasis](http://localhost/nomad-oasis) in your browser. - -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](https://nomad-lab.eu/prod/v1/docs/oasis/install.html) - -### For an existing Oasis - -If you already have an Oasis running you only need to change the image being pulled in -your `docker-compose.yaml` with `ghcr.io/GITHUB_REPOSITORY: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`. - -```yaml - volumes: - # - ./configs/nomad.yaml:/app/nomad.yaml -```