Merge pull request #125 from codecov/ElioDiNino/api-admin

feat: API admin endpoint options

Author: ElioDiNino

Dockerfile

@@ -9,13 +9,15 @@ COPY --chown=haproxy:haproxy --chmod=644 config/3-ssl.conf /etc/haproxy/3-ssl.co
 COPY --chown=haproxy:haproxy --chmod=644 config/1-backends.conf /etc/haproxy/1-backends.conf.template
 COPY --chown=haproxy:haproxy --chmod=644 config/1-minio.conf /etc/haproxy/1-minio.conf.template
 COPY --chown=haproxy:haproxy --chmod=644 config/2-http.conf /etc/haproxy/2-http.conf.template
-COPY --chown=haproxy:haproxy --chmod=644 config/codecov.map /etc/haproxy/codecov.map
+COPY --chown=haproxy:haproxy --chmod=644 config/codecov.map /etc/haproxy/codecov.map.template
 COPY --chown=haproxy:haproxy --chmod=644 config/proxy.map /etc/haproxy/proxy.map
 COPY --chown=haproxy:haproxy --chmod=644 config/minio.map /etc/haproxy/minio.map
 ENV CODECOV_API_HOST=api
 ENV CODECOV_API_PORT=8000
 ENV CODECOV_API_SCHEME=http
 ENV CODECOV_API_HOST_HEADER="%[req.hdr(Host)]"
+ENV CODECOV_API_ADMIN_ENABLED=false
+ENV CODECOV_API_ADMIN_PATH=admin
 ENV CODECOV_IA_HOST=api
 ENV CODECOV_IA_PORT=8000
 ENV CODECOV_IA_SCHEME=http

README.md

@@ -16,6 +16,8 @@ CODECOV_API_HOST=api # This is the host to access the codecov api
 CODECOV_API_PORT=8000 # The port to access the codecov api
 CODECOV_API_SCHEME=http # The scheme on which to access the codecov api. http or https
 CODECOV_API_HOST_HEADER="%[req.hdr(Host)]" # The host to send as the host header. Default passes through host. Useful to set for local envs.
+CODECOV_API_ADMIN_ENABLED=false # Enable/disable the admin endpoint proxy
+CODECOV_API_ADMIN_PATH=admin # The path for api's admin interface
 CODECOV_IA_HOST=api
 CODECOV_IA_PORT=8000
 CODECOV_IA_SCHEME=http

config/codecov.map

@@ -2,6 +2,7 @@
 ^/validate(\/)?$  be_api
 ^/static(\/.*)?$  be_api
 ^/internal(\/.*)?$  be_api
+${API_ADMIN_PATH_PREFIX}^/${CODECOV_API_ADMIN_PATH}(\/.*)?$  be_api
 ^/graphql(\/.*)?$  be_api
 ^/webhooks(\/.*)?$  be_api
 ^/frontend_health$  be_default

entrypoint.sh

@@ -91,6 +91,13 @@ _start_haproxy() {
   fi
   BACKENDS="-f /etc/haproxy/1-backends.conf"
   envsubst < /etc/haproxy/1-backends.conf.template > /etc/haproxy/1-backends.conf
+  if [ "$CODECOV_API_ADMIN_ENABLED" = "true" ]; then
+      echo 'Codecov api admin endpoint proxy enabled'
+  else
+      echo 'Codecov api admin endpoint proxy disabled'
+      export API_ADMIN_PATH_PREFIX="# (disabled) "
+  fi
+  envsubst < /etc/haproxy/codecov.map.template > /etc/haproxy/codecov.map
   MINIO_FILE=""
   if [ "$CODECOV_GATEWAY_MINIO_ENABLED" ] && [ "$routing_map" != "proxy" ]; then
       echo 'Codecov gateway minio enabled'
@@ -112,4 +119,3 @@ then
 else
   exec "$@"
 fi
-