From d28ec3587a3e2bfd23619dda3a1cb310de56bca3 Mon Sep 17 00:00:00 2001 From: jcfreeman2 Date: Wed, 11 Oct 2023 15:11:48 -0500 Subject: [PATCH] JCF: Update README.md --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index bf09fd8..6b80fb3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,13 +2,13 @@ To run one of the provided microservices in this repo, the basic command is the following: ``` -docker run --rm -e MICROSERVICE= ghcr.io/dune-daq/microservices:39be +docker run --rm -e MICROSERVICE= ghcr.io/dune-daq/microservices:77df ``` There are a couple of points to note: * The value of MICROSERVICE should be the name of a given microservice's subdirectory in this repo. As of Oct-6-2023, the available subdirectories are: `config-service`, `ers-dbwriter`, `logbook`, `opmon-dbwriter`, `runnumber-rest` and `runregistry-rest`. * Most microservices require additional environment variables to be set, which can be passed using the usual docker syntax: `-e VARIABLE_NAME=` * If you don't know what these additional environment variables are, you can just run the `docker` command as above without setting them; the container will exit out almost immediately but only after telling you what variables are missing -* The `39be` tag for the image in the example above just refers to the first four characters of the git commit of the microservices repo whose `dockerfiles/Dockerfile.microservices` Docker file was used to create the image +* The `77df` tag for the image in the example above just refers to the first four characters of the git commit of the microservices repo whose `dockerfiles/Dockerfile.microservices` Docker file was used to create the image. Currently [Oct-11-2023] this is the head of the `develop` branch. For details on a given microservice, look at its own README file (format is `docs/README_.md`). They may or may not be up to date, however.