static-webserver is now used to serve static content (ITISFoundation#2342)

* first step: serving statics from a different server

* disables setup_statics once more

* fixed treafik rule

* no static routes

* first fully working refactor of with the static-webserver

* refactoring and removing unused env vars

* fixing tests after outsourcing to static-webserver

* changed and split message on two lines

* removed usage of dockerfile_environ

* swarm deploy test fixes and additions

* minor refactor

* added readme

* added missing service

* regenerated spec

* refactor

* added static-webserver to the list of services to build

* adding debug info in stdout

* changed route name to fix issues with traefik rules

* added to codeowners

* making dockerfile more uniform with current patterns

* fixing some very old habit

* using better more proper names

* removing unsued unv vars

* adding more details

* removed caching from this service

* merged and moved settings

* updated graph with services

* reverting scope

* process starts with pid = 1

* ensuring process is running under user

* there are issues with the static-webserver running as non root

* static-server upgrade
enabling non root user
moved default port to 8000

* updated static-webserver port

* using the correct port

* refactor and getting codeclimate unstuck

* refactor and tring to make codeclimate work

* triggering codeclimate

Co-authored-by: Andrei Neagu <[email protected]>

Author: GitHK

.github/CODEOWNERS

@@ -28,11 +28,11 @@ Makefile                                  @pcrespov, @sanderegg
 /services/migration/                      @pcrespov
 /services/sidecar/                        @pcrespov, @mguidon
 /services/storage/                        @mguidon, @pcrespov
+/services/static-webserver                @GitHK
 /services/web/client/                     @odeimaiz, @ignapas
 /services/web/server/                     @pcrespov
 /tests/environment-setup/                 @pcrespov
 /tests/performance/                       @pcrespov
 /tests/public-api/                        @pcrespov
-
 requirements/*                            @pcrespov
 tools/*                                   @pcrespov

Makefile

@@ -36,7 +36,8 @@ SERVICES_LIST := \
 	migration \
 	sidecar \
 	storage \
-	webserver
+	webserver \
+	static-webserver
 
 CLIENT_WEB_OUTPUT       := $(CURDIR)/services/web/client/source-output
 

docs/img/.stack-simcore-version.yml.png

@@ -1468,7 +1468,7 @@
             "format": "uri"
           }
         },
-        "description": "A released solver with a specific version ",
+        "description": "A released solver with a specific version",
         "example": {
           "id": "simcore/services/comp/isolve",
           "version": "2.1.1",

services/api-server/openapi.json

@@ -87,6 +87,18 @@ services:
         org.label-schema.vcs-url: "${VCS_URL}"
         org.label-schema.vcs-ref: "${VCS_REF}"
 
+  static-webserver:
+    image: local/static-webserver:${BUILD_TARGET:?build_target_required}
+    build:
+      context: ../
+      dockerfile: services/static-webserver/Dockerfile
+      target: ${BUILD_TARGET:?build_target_required}
+      labels:
+        org.label-schema.schema-version: "1.0"
+        org.label-schema.build-date: "${BUILD_DATE}"
+        org.label-schema.vcs-url: "${VCS_URL}"
+        org.label-schema.vcs-ref: "${VCS_REF}"
+
   webserver:
     image: local/webserver:${BUILD_TARGET:?build_target_required}
     build:

services/docker-compose-build.yml

@@ -43,6 +43,12 @@ services:
       - ./director-v2:/devel/services/director-v2
       - ../packages:/devel/packages
 
+  static-webserver:
+    volumes:
+      - ./web/client/source-output:/static-content
+    environment:
+      - SERVER_LOG_LEVEL=info
+
   webserver:
     volumes:
       - ./web/server:/devel/services/web/server

services/docker-compose.devel.yml

@@ -113,6 +113,34 @@ services:
       - interactive_services_subnet
       - computational_services_subnet
 
+  static-webserver:
+    image: ${DOCKER_REGISTRY:-itisfoundation}/static-webserver:${DOCKER_IMAGE_TAG:-latest}
+    init: true
+    environment:
+      - SERVER_HOST=0.0.0.0
+      - SERVER_PORT=8000
+      - SERVER_LOG_LEVEL=error
+      - SERVER_ROOT=/static-content
+    deploy:
+      placement:
+        constraints:
+          - node.platform.os == linux
+      labels:
+        - io.simcore.zone=${TRAEFIK_SIMCORE_ZONE}
+        - traefik.http.middlewares.${SWARM_STACK_NAME}_gzip.compress=true
+        - traefik.enable=true
+        - traefik.http.services.${SWARM_STACK_NAME}_static_webserver.loadbalancer.server.port=8000
+        - traefik.http.services.${SWARM_STACK_NAME}_static_webserver.loadbalancer.healthcheck.path=/
+        - traefik.http.services.${SWARM_STACK_NAME}_static_webserver.loadbalancer.healthcheck.interval=2000ms
+        - traefik.http.services.${SWARM_STACK_NAME}_static_webserver.loadbalancer.healthcheck.timeout=1000ms
+        - traefik.http.middlewares.${SWARM_STACK_NAME}_static_webserver_retry.retry.attempts=2
+        - traefik.http.routers.${SWARM_STACK_NAME}_static_webserver.rule=hostregexp(`{host:.+}`) && (PathPrefix(`/osparc`) || PathPrefix(`/s4l`) || PathPrefix(`/tis`) || PathPrefix(`/transpiled`) || PathPrefix(`/resource`))
+        - traefik.http.routers.${SWARM_STACK_NAME}_static_webserver.entrypoints=http
+        - traefik.http.routers.${SWARM_STACK_NAME}_static_webserver.priority=2
+        - traefik.http.routers.${SWARM_STACK_NAME}_static_webserver.middlewares=${SWARM_STACK_NAME}_gzip@docker, ${SWARM_STACK_NAME}_static_webserver_retry
+    networks:
+      - default
+
   webserver:
     image: ${DOCKER_REGISTRY:-itisfoundation}/webserver:${DOCKER_IMAGE_TAG:-latest}
     init: true
@@ -147,7 +175,7 @@ services:
         - traefik.http.services.${SWARM_STACK_NAME}_webserver.loadbalancer.healthcheck.interval=2000ms
         - traefik.http.services.${SWARM_STACK_NAME}_webserver.loadbalancer.healthcheck.timeout=1000ms
         - traefik.http.middlewares.${SWARM_STACK_NAME}_webserver_retry.retry.attempts=2
-        - traefik.http.routers.${SWARM_STACK_NAME}_webserver.rule=hostregexp(`{host:.+}`)
+        - traefik.http.routers.${SWARM_STACK_NAME}_webserver.rule=hostregexp(`{host:.+}`) && (PathPrefix(`/`) || PathPrefix(`/v0`) || PathPrefix(`/socket.io`) || PathPrefix(`/static-frontend-data.json`))
         - traefik.http.routers.${SWARM_STACK_NAME}_webserver.entrypoints=http
         - traefik.http.routers.${SWARM_STACK_NAME}_webserver.priority=1
         - traefik.http.routers.${SWARM_STACK_NAME}_webserver.middlewares=${SWARM_STACK_NAME}_gzip@docker, ${SWARM_STACK_NAME_NO_HYPHEN}_sslheader@docker, ${SWARM_STACK_NAME}_webserver_retry

services/docker-compose.yml

@@ -0,0 +1,31 @@
+FROM joseluisq/static-web-server:1.16.0-alpine as base
+
+LABEL [email protected]
+
+# simcore-user uid=8004(scu) gid=8004(scu) groups=8004(scu)
+ENV SC_USER_ID=8004 \
+    SC_USER_NAME=scu \
+    SC_BUILD_TARGET=base \
+    SC_BOOT_MODE=default
+
+RUN adduser -D -u ${SC_USER_ID} -s /bin/sh -h /home/${SC_USER_NAME} ${SC_USER_NAME}
+
+# front-end client last (image name is the path to the Dockerfile)
+COPY --from=client/tools/qooxdoo-kit/builder:latest --chown=${SC_USER_NAME}:${SC_USER_NAME} \
+    /project/build-output "/static-content"
+
+# changing ownership of static-web-server files
+RUN chown -R ${SC_USER_NAME}:${SC_USER_NAME} /entrypoint.sh
+RUN chown -R ${SC_USER_NAME}:${SC_USER_NAME} /usr/local/bin/static-web-server
+RUN chown -R ${SC_USER_NAME}:${SC_USER_NAME} /public
+
+USER ${SC_USER_NAME}
+
+FROM base as build
+ENV SC_BUILD_TARGET build
+
+FROM base as production
+ENV SC_BUILD_TARGET production
+
+FROM base as development
+ENV SC_BUILD_TARGET development

services/static-webserver/Dockerfile

@@ -0,0 +1,10 @@
+# static-webserver
+
+Used for static content serving.
+
+### Furtherr steps
+
+In the future will fully serve all static content. Currently the `webserver` is still serving the following routes:
+
+- `/` resolves to one of the three index.html pages inside the three products (osparc, tis, s4l)
+- `/static-frontend-data.json` contains information required by the fronted

services/static-webserver/README.md

@@ -45,8 +45,6 @@ ENV PYTHONDONTWRITEBYTECODE=1 \
 ENV PATH="${VIRTUAL_ENV}/bin:$PATH"
 
 
-# TODO: rename with common prefix!
-ENV SIMCORE_WEB_OUTDIR /home/scu/services/web/client
 # TODO: eliminate this variable!
 ENV IS_CONTAINER_CONTEXT Yes
 
@@ -59,9 +57,6 @@ EXPOSE 8080
 #
 # + /build             WORKDIR
 #    + packages
-#    + services/web/client         $SIMCORE_WEB_OUTDIR
-#       - index.html
-#        ...
 #    + services/web/server
 #       + src
 #       + tests
@@ -150,10 +145,6 @@ RUN apt-get update \
 COPY --chown=scu:scu services/web/server/docker services/web/server/docker
 RUN chmod +x services/web/server/docker/*.sh
 
-# front-end client last (image name is the path to the Dockerfile)
-COPY --from=client/tools/qooxdoo-kit/builder:latest --chown=scu:scu \
-      /project/build-output "${SIMCORE_WEB_OUTDIR}"
-
 HEALTHCHECK --interval=30s \
       --timeout=120s \
       --start-period=30s \
@@ -177,8 +168,6 @@ FROM build as development
 
 ENV SC_BUILD_TARGET development
 
-ENV SIMCORE_WEB_OUTDIR /devel/services/web/client
-
 WORKDIR /devel
 
 RUN chown -R scu:scu "${VIRTUAL_ENV}"