git.iko.soy/typeable/oauth2-proxy
on master help sign in
Merge pull request #1117 from oauth2-proxy/deprecate-gcp-healthcheck

Deprecate GCP HealthCheck option

commitf0963b3444ae331d5b906206a0d7664963cc54cb authorJoel Speed <Joel.speed@hotmail.co.uk> dateSun 21 Mar 2021, 20:13 (6 years ago) parent455d6492e5b229
3 files changed+6−1
compare with master
unifiedsplit
CHANGELOG.md+5 docs/docs/configuration/overview.md−1 oauthproxy.go+1
CHANGELOG.md+5
@@ -7,11 +7,16 @@
77- [#1103](https://github.com/oauth2-proxy/oauth2-proxy/pull/1103) Upstream request signatures via `--signature-key` is
88 deprecated. Support will be removed completely in v8.0.0.
99- [1087](https://github.com/oauth2-proxy/oauth2-proxy/pull/1087) The default logging templates have been updated to include {{.RequestID}}
10+- [#1117](https://github.com/oauth2-proxy/oauth2-proxy/pull/1117) The `--gcp-healthchecks` option is now deprecated. It will be removed in a future release.
11+ - To migrate, you can change your application health checks for OAuth2 Proxy to point to
12+ the `--ping-path` value.
13+ - You can also migrate the user agent based health check using the `--ping-user-agent` option. Set it to `GoogleHC/1.0` to allow health checks on the path `/` from the Google health checker.
1014
1115## Breaking Changes
1216
1317## Changes since v7.0.1
1418
19+- [#1117](https://github.com/oauth2-proxy/oauth2-proxy/pull/1117) Deprecate GCP HealthCheck option (@JoelSpeed)
1520- [#1104](https://github.com/oauth2-proxy/oauth2-proxy/pull/1104) Allow custom robots text pages (@JoelSpeed)
1621- [#1045](https://github.com/oauth2-proxy/oauth2-proxy/pull/1045) Ensure redirect URI always has a scheme (@JoelSpeed)
1722- [#1103](https://github.com/oauth2-proxy/oauth2-proxy/pull/1103) Deprecate upstream request signatures (@NickMeves)
docs/docs/configuration/overview.md−1
@@ -50,7 +50,6 @@ An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/
5050| `--force-https` | bool | enforce https redirect | `false` |
5151| `--banner` | string | custom (html) banner string. Use `"-"` to disable default banner. | |
5252| `--footer` | string | custom (html) footer string. Use `"-"` to disable default footer. | |
53−| `--gcp-healthchecks` | bool | will enable `/liveness_check`, `/readiness_check`, and `/` (with the proper user-agent) endpoints that will make it work well with GCP App Engine and GKE Ingresses | false |
5453| `--github-org` | string | restrict logins to members of this organisation | |
5554| `--github-team` | string | restrict logins to members of any of these teams (slug), separated by a comma | |
5655| `--github-repo` | string | restrict logins to collaborators of this repository formatted as `orgname/repo` | |
oauthproxy.go+1
@@ -302,6 +302,7 @@ func buildPreAuthChain(opts *options.Options) (alice.Chain, error) {
302302 healthCheckPaths := []string{opts.PingPath}
303303 healthCheckUserAgents := []string{opts.PingUserAgent}
304304 if opts.GCPHealthChecks {
305+ logger.Printf("WARNING: GCP HealthChecks are now deprecated: Reconfigure apps to use the ping path for liveness and readiness checks, set the ping user agent to \"GoogleHC/1.0\" to preserve existing behaviour")
305306 healthCheckPaths = append(healthCheckPaths, "/liveness_check", "/readiness_check")
306307 healthCheckUserAgents = append(healthCheckUserAgents, "GoogleHC/1.0")
307308 }