Add spreadsheet config server (#432)

Signed-off-by: achour94 <[email protected]>

Author: achour94

.github/workflows/main.yml

@@ -47,6 +47,7 @@ on:
       - voltage_init_server_updated
       - case_import_server_updated
       - gridadmin_app_updated
+      - spreadsheet_config_server_updated
 
 jobs:
   build:

README.md

@@ -214,6 +214,7 @@ http://localhost:5011/swagger-ui.html  // case-validation-server
 http://localhost:5033/swagger-ui.html  // user-admin-server
 http://localhost:5030/swagger-ui.html  // sensitivity-analysis-server
 http://localhost:5031/swagger-ui.html  // shortcircuit-server
+http://localhost:5035/swagger-ui.html  // spreadsheet-config-server
 http://localhost:5037/swagger-ui.html  // timeseries-server
 http://localhost:5038/swagger-ui.html  // voltage-init-server
 http://localhost:5039/swagger-ui.html  // case-import-server
@@ -412,6 +413,7 @@ http://<INGRESS_HOST>/shortcircuit-server/swagger-ui.html
 http://<INGRESS_HOST>/timeseries-server/swagger-ui.html
 http://<INGRESS_HOST>/voltage-init-server/swagger-ui.html
 http://<INGRESS_HOST>/case-import-server/swagger-ui.html
+http://<INGRESS_HOST>/spreadsheet-config-server/swagger-ui.html
 ```
 
 ## How to use a local docker image into Minikube?

docker-compose/docker-compose.base.yml

@@ -129,6 +129,38 @@ services:
         limits:
           memory: 384m
 
+  spreadsheet-config-server:
+    profiles:
+      - all
+      - suite
+      - study
+      - study-light
+      - merging
+      - dynamic-mapping
+      - dynamic-simulation
+      - import
+    image: gridsuite/spreadsheet-config-server:latest
+    ports:
+      - 5035:80
+    volumes:
+      - $PWD/../../k8s/resources/common/config/spreadsheet-config-server-application.yml:/config/specific/application.yml:Z
+      - $PWD/../../k8s/resources/common/config/common-application.yml:/config/common/application.yml:Z
+    restart: unless-stopped
+    depends_on:
+      logspout:
+        condition: "service_started"
+        required: false
+    command: --server.port=80 --spring.config.additional-location=/config/
+    sysctls:
+      - net.ipv4.ip_unprivileged_port_start=0 # for docker < 20.03.0
+    environment:
+      - JAVA_TOOL_OPTIONS=-Xmx96m
+    memswap_limit: 384m
+    deploy:
+      resources:
+        limits:
+          memory: 384m
+
   report-server:
     profiles:
       - all

docker-compose/technical/create-postgres-databases.sh

@@ -29,6 +29,7 @@ psql --username $POSTGRES_USER --dbname $POSTGRES_DEFAULT_DB <<-EOSQL
   create database "${DATABASE_PREFIX_NAME}voltageinit";
   create database "${DATABASE_PREFIX_NAME}loadflow";
   create database "${DATABASE_PREFIX_NAME}stateestimation";
+  create database "${DATABASE_PREFIX_NAME}spreadsheetconfig";
 EOSQL
 }
 

k8s/live/local/kustomization.yaml

@@ -48,6 +48,7 @@ resources:
   - shortcircuit-server-ingress.yaml
   - timeseries-server-ingress.yaml
   - voltage-init-server-ingress.yaml
+  - spreadsheet-config-server-ingress.yaml
 
 configMapGenerator:
   - name: gridapps-env-configmap

k8s/live/local/spreadsheet-config-server-ingress.yaml

@@ -0,0 +1,37 @@
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: spreadsheet-config-server-ingress
+  annotations:
+    nginx.ingress.kubernetes.io/configuration-snippet: |
+      # our containers host at '/' so can't possibly make a difference between
+      # '/XXX/' and '/XXX' (trailing slash) (which would respectively become
+      # '/' and '' inside the container but an empty path doesn't exist in http)
+      # so always redirect '/XXX' to '/XXX/' in the client outside the container
+      rewrite ^/spreadsheet-config-server$ /spreadsheet-config-server/ permanent;
+
+      # springfox swagger-ui uses X-Forwarded-Prefix to find the
+      # base url when behind a reverse proxy.
+      # nginx-ingress-controller has an annotation to do the same thing
+      # (nginx.ingress.kubernetes.io/x-forwarded-prefix)
+      # but it only works when using rewrite-target, which we can't use because
+      # we have properly encoded slashs in urls
+      proxy_set_header X-Forwarded-Prefix         /spreadsheet-config-server/;
+
+      # using this instead of standard rewrite as a workaround to avoid decoding slashes in urls
+      # we sometimes have ids in the urls that contain properly encoded slashes
+      if ($request_uri ~ "^/spreadsheet-config-server(/.*)") {
+        proxy_pass http://upstream_balancer$1;
+        break;
+      }
+spec:
+  rules:
+  - http:
+      paths:
+      - path: /spreadsheet-config-server(/|$)
+        pathType: Prefix
+        backend:
+          service:
+            name: spreadsheet-config-server
+            port:
+              number: 80

k8s/resources/common/config/spreadsheet-config-server-application.yml

@@ -34,6 +34,8 @@ resources:
   - config-notification-server-service.yaml
   - user-admin-server-deployment.yaml
   - user-admin-server-service.yaml
+  - spreadsheet-config-server-deployment.yaml
+  - spreadsheet-config-server-service.yaml
 
 configMapGenerator:
   - name: default-backend-htdocs-configmap
@@ -89,3 +91,6 @@ configMapGenerator:
   - name: user-admin-server-configmap-specific
     files:
       - application.yml=config/user-admin-server-application.yml
+  - name: spreadsheet-config-server-configmap-specific
+    files:
+      - application.yml=config/spreadsheet-config-server-application.yml

k8s/resources/common/kustomization.yaml

@@ -0,0 +1,30 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: spreadsheet-config-server
+  labels:
+    name: spreadsheet-config-server
+    version: "1"
+    app.kubernetes.io/component: gridsuite-springboot
+    gridsuite.org/springboot-with-database: "true"
+  annotations:
+    gridsuite.org/size: springboot-xxs
+spec:
+  selector:
+    matchLabels:
+      name: spreadsheet-config-server
+  template:
+    metadata:
+      labels:
+        name: spreadsheet-config-server
+    spec:
+      containers:
+        - name: main
+          image: docker.io/gridsuite/spreadsheet-config-server:latest
+          volumeMounts:
+            - mountPath: /config/specific
+              name: spreadsheet-config-server-configmap-specific-volume
+      volumes:
+        - name: spreadsheet-config-server-configmap-specific-volume
+          configMap:
+            name: spreadsheet-config-server-configmap-specific

k8s/resources/common/spreadsheet-config-server-deployment.yaml

@@ -0,0 +1,10 @@
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    name: spreadsheet-config-server
+    app.kubernetes.io/component: gridsuite-springboot
+  name: spreadsheet-config-server
+spec:
+  selector:
+    name: spreadsheet-config-server