EDGFQM-4 - Update README and MD

This commit corrects a typo in the README and adds some details around configuring the project for deployment It also adds the environment variables to the module descriptor
folio-org · Aug 30, 2023 · adab1c7 · adab1c7
1 parent 9c25509
commit adab1c7
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -16,14 +16,27 @@ The purpose of this edge API is to bridge the gap between 3rd party discovery se
 # Security
 The edge-fqm API is secured via the facilities provided by edge-common. More specifically, via API Key. See edge-common for additional details.See [edge-common-spring](https://github.com/folio-org/edge-common-spring)
 
+# Installation/Deployment
+
 ## Configuration
 
 * See [edge-common](https://github.com/folio-org/edge-common) for a description of how configuration works.
 
 ***System properties***
-Property                   | Default                                    | Description
-------------------------   | -----------                                | -------------
-`port`                     | `8081`                                     | Server port to listen on
-`okapi_url`                | `http://okapi:9130`	                      | Okapi (URL)
-`secure_store`             | `Ephemeral`                                | Type of secure store to use.  Valid: `Ephemeral`, `AwsSsm`, `Vault`
-`secure_store_props`       | `src/main/resources/ephemeral.properties`  | Path to a properties file specifying secure store configuration
+
+| Property             | Default                                   | Description                                                         |
+|----------------------|-------------------------------------------|---------------------------------------------------------------------|
+| `server.port`        | `8081`                                    | Server port to listen on                                            |
+| `okapi_url`          | `http://okapi:9130`	                      | Okapi (URL)                                                         |
+| `secure_store`       | `Ephemeral`                               | Type of secure store to use.  Valid: `Ephemeral`, `AwsSsm`, `Vault` |
+| `secure_store_props` | `src/main/resources/ephemeral.properties` | Path to a properties file specifying secure store configuration     |
+
+
+### Configuring spring-boot
+
+Spring boot properties can be overridden using the specified environment variables, if it is not it can be done using
+one of the following approaches (see also the
+documentation [Spring Boot Externalized Configuration](https://docs.spring.io/spring-boot/docs/1.5.6.RELEASE/reference/html/boot-features-external-config.html)):
+
+1. Using the environment variable `SPRING_APPLICATION_JSON` (example: `SPRING_APPLICATION_JSON='{"foo":{"bar":"spam"}}'`)
+2. Using the system variables within the `JAVA_OPTIONS` (example: `JAVA_OPTIONS=-Xmx400m -Dserver.port=1234`)
diff --git a/descriptors/ModuleDescriptor-template.json b/descriptors/ModuleDescriptor-template.json
@@ -22,8 +22,21 @@
       }
     },
     "env": [
-      { "name": "JAVA_OPTIONS",
+      {
+        "name": "JAVA_OPTIONS",
         "value": "-XX:MaxRAMPercentage=66.0"
+      },
+      {
+        "name": "okapi_url",
+        "value": "http://okapi:9130"
+      },
+      {
+        "name": "secure_store",
+        "value": "Ephemeral"
+      },
+      {
+        "name": "secure_store_props",
+        "value": "src/main/resources/ephemeral.properties"
       }
     ]
   }