diff options
| author | mo khan <mo@mokhan.ca> | 2025-07-21 16:04:59 -0600 |
|---|---|---|
| committer | mo khan <mo@mokhan.ca> | 2025-07-21 16:04:59 -0600 |
| commit | 5f76ebe3b95b491a7a07ddb9dd5799735cf3e159 (patch) | |
| tree | dd7dcf8e78ea554d071ad502f92b7908687daa3e /share/man | |
| parent | b83a9995fb68cba801f5d202419237355c16df38 (diff) | |
docs: update envoy documentation
Diffstat (limited to 'share/man')
| -rw-r--r-- | share/man/ENVOY.md | 33 |
1 files changed, 9 insertions, 24 deletions
diff --git a/share/man/ENVOY.md b/share/man/ENVOY.md index 4b5d765..c4c0eac 100644 --- a/share/man/ENVOY.md +++ b/share/man/ENVOY.md @@ -916,32 +916,17 @@ COPY etc/ etc COPY bin/*.sh bin/ RUN chmod +x bin/*.sh ENTRYPOINT ["/usr/bin/dumb-init", "--"] -CMD ["/opt/sparkle/bin/entrypoint.sh"] +CMD ["/bin/minit"] ``` -The entrypoint script uses dumb-init as PID 1 to forward signals to child -processes. Sparkle is started up with on a limited set of environment variables. -Environment variables such as `HMAC_SECRET` and `OAUTH_CLIENT_SECRET` are not -available to sparkle. +The entrypoint uses dumb-init as PID 1 to forward signals to child +processes. minit searches for a Procfile and starts a process for each row in +the file. -```sh -#!/usr/bin/dumb-init /bin/sh -# shellcheck shell=sh -set -e - -[ -n "$DEBUG" ] && set -x - -cd "$(dirname "$0")/.." - -./bin/envoy.sh & # launch envoy in background -./bin/authzd & # launch authzd in background - -/usr/bin/env -i - \ - APP_ENV="$APP_ENV" \ - BIND_ADDR="$BIND_ADDR" \ - OAUTH_CLIENT_ID="$OAUTH_CLIENT_ID" \ - OIDC_ISSUER="$OIDC_ISSUER" \ - ./bin/sparkled # launch sparkled in foreground +```Procfile +envoy: ./bin/envoy-shim +authzd: ./bin/authzd +sparkled: ./bin/sparkled ``` ## Summary @@ -963,7 +948,7 @@ authentication/authorization strategy that GitLab as a whole supports. ## References * [Envoy Proxy](https://www.envoyproxy.io/) -* [OpenID Core Specificatioin](https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) +* [OpenID Core Specification](https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) * [RFC-7519: JSON Web Token (JWT)](https://datatracker.ietf.org/doc/html/rfc7519) * [`envoy.filters.http.oauth2`](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/oauth2_filter.html) * [`envoy.filters.http.jwt_authn`](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/jwt_authn/v3/config.proto) |