From 924be7bd690a28cc1aaaf46ebcadf5a0548bbb97 Mon Sep 17 00:00:00 2001
From: Joe Corall <jjc223@lehigh.edu>
Date: Fri, 26 Apr 2024 15:55:30 -0400
Subject: [PATCH] Add new microservice steps to README

---
 README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)

diff --git a/README.md b/README.md
index ef533df..60cfc6a 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,68 @@
 
 Any microservice that takes stdin as input and returns a stream to stdout can use scyllaridae to facilitate its execution.
 
+## Adding a new microservice
+
+### Create the microservice
+
+`Dockerfile`
+```dockerfile
+ARG TAG=main
+ARG DOCKER_REPOSITORY=local
+FROM ${DOCKER_REPOSITORY}/scyllaridae:${TAG}
+
+RUN apk update && \
+    apk add --no-cache curl
+
+COPY scyllaridae.yml /app/scyllaridae.yml
+```
+
+`scyllaridae.yml`
+```yaml
+allowedMimeTypes:
+  - "*"
+cmdByMimeType:
+  default:
+    cmd: "curl"
+    args:
+      - "http://fits:8080/fits/examine"
+      - "-X"
+      - "POST"
+      - "-F"
+      - "datafile=@-"
+```
+
+### Deploy your new microservice
+
+Update your ISLE docker-compose.yml to deploy the service's docker image defined above
+
+```yaml
+    fits-dev: &pandoc
+        <<: [*dev, *common]
+        image: ${DOCKER_REPOSITORY}/scyllaridae-fits:main
+        networks:
+            default:
+                aliases:
+                    - fits
+    fits-prod: &pandoc-prod
+        <<: [*prod, *pandoc]
+```
+
+### Configure alpaca and Drupal
+
+Until we define a subscription spec for Islandora Events in this repo, you'll also need to:
+
+3. Update alpaca.properties
+```
+derivative.QUEUE-NAME.enabled=true
+derivative.QUEUE-NAME.in.stream=queue:islandora-connector-QUEUE-NAME
+derivative.QUEUE-NAME.service.url=http://QUEUE-NAME:8080/
+derivative.QUEUE-NAME.concurrent-consumers=-1
+derivative.QUEUE-NAME.max-concurrent-consumers=-1
+derivative.QUEUE-NAME.async-consumer=true
+```
+4. Add an action in Islandora with your `islandora-connector-QUEUE-NAME` specified
+5. Add a context to trigger the action you created in step 4
 
 ## Attribution