data-proxy concept

birdhouse/components/dggs/.gitignore

@@ -1,4 +1,5 @@
 config/dggs/pydggsapi-config.json
 config/magpie/config.yml
 config/proxy/conf.extra-service.d/dggs.conf
+config/data-proxy/conf.extra-service.d/dggs.conf
 service-config.json

birdhouse/components/dggs/config/data-proxy/conf.extra-service.d/dggs.conf.template

@@ -0,0 +1,5 @@
+    location ${DGGS_DATA_PROXY_URL_PATH}/ {
+        ${SECURE_DATA_PROXY_AUTH_INCLUDE}
+
+        alias /data/data-proxy/${DGGS_API_NAME}/;
+    }

birdhouse/components/dggs/config/data-proxy/docker-compose-extra.yml

@@ -0,0 +1,5 @@
+services:
+  proxy:
+    volumes:
+      - ./components/dggs/config/data-proxy/conf.extra-service.d/dggs.conf:/etc/nginx/conf.extra-service.d/data-proxy/dggs.conf:ro
+      - ${DGGS_DATA_PROXY_DIR_PATH}:/data/data-proxy/${DGGS_API_NAME}:ro

birdhouse/components/dggs/default.env

@@ -14,11 +14,21 @@ export DGGS_IMAGE='ghcr.io/${DGGS_DOCKER}:${DGGS_VERSION}'
 export DGGS_IMAGE_URI='${DGGS_IMAGE}'
 
 # can be used to load local data into the container and cross-referencing it in the PyDGGS-API configuration
-# otherwise, 'optional-components/secure-data-proxy' can be used to provide access to data via the Web
+# otherwise, 'optional-components/data-proxy' (see below) can be used to provide access to data via the Web
 # static files placed under 'DGGS_DATA_DIR' will be mapped to '/data' within the container, but NOT served on the Web
 # this location *could* be used by the service to cache precomputed data to accelerate future access
 export DGGS_DATA_DIR='${BIRDHOUSE_DATA_PERSIST_ROOT}/dggs'
 
+# following applies when 'optional-components/data-proxy' is enabled (public by default)
+# can be protected when combined with 'optional-components/secure-data-proxy'
+# data placed under 'DGGS_DATA_PROXY_DIR_PATH' on the host will be served on the web via 'DGGS_DATA_PROXY_URL_PATH'
+# NOTE:
+#   while serving PyDGGS-API data from this location is possible,
+#   it is NOT recommended as it would be much slower that using the local 'DGGS_DATA_DIR'
+#   the service will also have trouble accessing the file if protected by 'optional-components/secure-data-proxy'
+export DGGS_DATA_PROXY_DIR_PATH='${BIRDHOUSE_DATA_PERSIST_ROOT}/data-proxy/dggs'
+export DGGS_DATA_PROXY_URL_PATH='/data/${DGGS_API_NAME}'
+
 # path of the configuration file known to PyDGGS-API
 # by default, uses the file generated from the sample template to provide one example allowing API startup
 # if other DGGRS definitions or DGGS data sources are desired, it should be overridden entirely within this variable
@@ -88,6 +98,8 @@ OPTIONAL_VARS="
   \$DGGS_API_TITLE
   \$DGGS_API_DESCRIPTION
   \$DGGS_API_CONTACT
+  \$DGGS_DATA_PROXY_DIR_PATH
+  \$DGGS_DATA_PROXY_URL_PATH
   \$SECURE_DATA_PROXY_AUTH_INCLUDE
 "
 
@@ -98,6 +110,8 @@ export DELAYED_EVAL="
   DGGS_DATA_DIR
   DGGS_API_PATH
   DGGS_TILES_PATH
+  DGGS_DATA_PROXY_DIR_PATH
+  DGGS_DATA_PROXY_URL_PATH
 "
 
 COMPONENT_DEPENDENCIES="

birdhouse/optional-components/README.rst

@@ -175,6 +175,38 @@ The anonymous user will now have all the permissions described in |magpie-public
 .. |magpie-public-perms| replace:: optional-components/all-public-access/all-public-access-magpie-permission.cfg
 .. _env.local.example: ../env.local.example
 
+
+.. _optional-components_data-proxy:
+
+Provide web access to generic data
+--------------------------------------------------------
+
+It is possible to serve static data files through Nginx by mapping a directory to a specific URL path.
+This optional component provides a configurable location to serve such data.
+
+.. seealso::
+    Can be combined with :ref:`optional-components/secure-data-proxy <optional-components_secure-data-proxy>`
+    to control access to the data. Otherwise, it is public by default.
+
+This component does not do anything on its own. It has to be combined with other components to make their
+corresponding locations available through the web.
+
+Enabling ``components/<SERVICE>`` with ``optional-components/data-proxy`` will make the following variables available:
+- ``<SERVICE>_DATA_PROXY_URL_PATH``: web access location to the data
+- ``<SERVICE>_DATA_PROXY_DIR_PATH``: host machine directory to the data
+
+By default, all services will employ ``/data/data-proxy/<service>`` as the host directory and ``/data/<service>``
+as web serving location. They can be configured globally or per service using relevant configuration variables.
+
+How to enable in ``env.local`` (a copy from `env.local.example`_ (:download:`download </birdhouse/env.local.example>`)):
+
+* Add ``./optional-components/data-proxy`` to ``BIRDHOUSE_EXTRA_CONF_DIRS``.
+* Optionally, configure alternate locations.
+* Optionally, combine with ``./optional-components/secure-data-proxy`` to control access to the data.
+* Enable another component supporting this cross-component capability.
+
+.. _optional-components_secure-data-proxy:
+
 Control secured access to generic data
 --------------------------------------------------------
 

birdhouse/optional-components/data-proxy/.gitkeep

@@ -0,0 +1,3 @@
+# Ensure the component is detected when added to 'BIRDHOUSE_EXTRA_CONF_DIRS'
+# However, specific configurations for it are defined across other services
+# Look for '..._DATA_PROXY_...' variables