Added SCL Validator to Docker Compose.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

.gitignore

@@ -8,3 +8,8 @@ target
 # IDE specific
 .idea
 *.iml
+
+# Data Directories for Docker Compose
+# Ignore all files, except the README.md
+compas/data/**/*.*
+!compas/data/**/README.md

README.md

@@ -69,14 +69,21 @@ docker-compose -f compas/docker-compose-postgresql.yml down -v
 
 The option '-v' also removes the volumes created, so all data is lost with this option.
 
+## Docker Compose (Common)
+
+### Custom files
+
+The SCL Validator Service can be extended with custom OCL and NSDOC Files. These can be placed in specific directories,
+see [OCL Files](compas/data/ocl/README.md) and [NSDOC Files](compas/data/nsdoc/README.md).
+
 ### Known issue with Docker Compose
 
 Using the current configuration with Keycloak and OpenResty (lua-resty-session) sometimes gives an error 
 "**state from argument does not match state restored from session**". 
 This mostly happens after using logout or the session is expired. The login page is shown, but after login this error is shown.
 Just open the url [http://localhost/](http://localhost/) again and OpenSCD is shown again, also being logged in.
 
-## Keycloak Demo Configuration
+### Keycloak Demo Configuration
 For demo purposes, a [demo Keycloak configuration](compas/keycloak/keycloak_compas_realm.json) is created which can be imported when
 running a Keycloak instance.
 

compas/data/nsdoc/README.md

@@ -0,0 +1,9 @@
+This directory can be used to add NSDOC Files to be served by the SCL Validator Service for the frontend application.
+
+For instance
+```
+compas/data
+└── nsdoc
+    ├── Official-File73.nsdoc
+    └── README.md
+```

compas/data/ocl/README.md

@@ -0,0 +1,19 @@
+This directory can be used to add custom OCL Files to the validation process.
+
+You can use subdirectories like `SemanticConstraints` as RiseClipse is doing.
+And there is a special filter that when you create a directory `FileSpecifics`.
+In this directory you can create for instance a directory `CID` to put constraints specific for an SCL File Type.
+Known types are `SSD`, `IID`, `ICD`, `SCD`, `CID`, `SED`, `ISD`, `STD`.
+
+For instance,
+
+```
+compas/data
+└── ocl
+    ├── FileSpecifics
+    │         └── CID
+    │             └── Busbar.ocl
+    ├── README.md
+    └── SemanticConstraints
+        └── Busbar.ocl
+```

compas/docker-compose-basex.yml

@@ -111,7 +111,7 @@ services:
   scl-validator:
     labels:
       compas: true
-    image: "lfenergy/compas-scl-validator:local-SNAPSHOT"
+    image: "lfenergy/compas-scl-validator:0.1.0"
     ports:
       - "9093:8080"
     environment:
@@ -129,13 +129,16 @@ services:
       interval: 15s
       timeout: 10s
       retries: 5
+    volumes:
+      - ./data/ocl:/data/ocl
+      - ./data/nsdoc:/data/nsdoc
     depends_on:
       - keycloak
 
   open-scd:
     labels:
       compas: true
-    image: "lfenergy/compas-open-scd:v0.12.0.0"
+    image: "lfenergy/compas-open-scd:v0.12.0.1"
     healthcheck:
       test: ["CMD", "curl", "-f", "http://localhost/"]
       interval: 30s

compas/docker-compose-postgresql.yml

@@ -118,7 +118,7 @@ services:
   scl-validator:
     labels:
       compas: true
-    image: "lfenergy/compas-scl-validator:local-SNAPSHOT"
+    image: "lfenergy/compas-scl-validator:0.1.0"
     ports:
       - "9093:8080"
     environment:
@@ -136,13 +136,16 @@ services:
       interval: 15s
       timeout: 10s
       retries: 5
+    volumes:
+      - ./data/ocl:/data/ocl
+      - ./data/nsdoc:/data/nsdoc
     depends_on:
       - keycloak
 
   open-scd:
     labels:
       compas: true
-    image: "lfenergy/compas-open-scd:v0.12.0.0"
+    image: "lfenergy/compas-open-scd:v0.12.0.1"
     healthcheck:
       test: ["CMD", "curl", "-f", "http://localhost/"]
       interval: 30s