git.iko.soy/typeable/oauth2-proxy
on master help sign in
Merge pull request #1117 from oauth2-proxy/deprecate-gcp-healthcheck
f0963b3Joel Speed
CHANGELOG.md+5
compare with master
unifiedsplit
@@ -7,11 +7,16 @@
7- [#1103](https://github.com/oauth2-proxy/oauth2-proxy/pull/1103) Upstream request signatures via `--signature-key` is
7- [#1103](https://github.com/oauth2-proxy/oauth2-proxy/pull/1103) Upstream request signatures via `--signature-key` is
8 deprecated. Support will be removed completely in v8.0.0.
8 deprecated. Support will be removed completely in v8.0.0.
9- [1087](https://github.com/oauth2-proxy/oauth2-proxy/pull/1087) The default logging templates have been updated to include {{.RequestID}}
9- [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.
10
14
11## Breaking Changes
15## Breaking Changes
12
16
13## Changes since v7.0.1
17## Changes since v7.0.1
14
18
19+- [#1117](https://github.com/oauth2-proxy/oauth2-proxy/pull/1117) Deprecate GCP HealthCheck option (@JoelSpeed)
15- [#1104](https://github.com/oauth2-proxy/oauth2-proxy/pull/1104) Allow custom robots text pages (@JoelSpeed)
20- [#1104](https://github.com/oauth2-proxy/oauth2-proxy/pull/1104) Allow custom robots text pages (@JoelSpeed)
16- [#1045](https://github.com/oauth2-proxy/oauth2-proxy/pull/1045) Ensure redirect URI always has a scheme (@JoelSpeed)
21- [#1045](https://github.com/oauth2-proxy/oauth2-proxy/pull/1045) Ensure redirect URI always has a scheme (@JoelSpeed)
17- [#1103](https://github.com/oauth2-proxy/oauth2-proxy/pull/1103) Deprecate upstream request signatures (@NickMeves)
22- [#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/
50| `--force-https` | bool | enforce https redirect | `false` |
50| `--force-https` | bool | enforce https redirect | `false` |
51| `--banner` | string | custom (html) banner string. Use `"-"` to disable default banner. | |
51| `--banner` | string | custom (html) banner string. Use `"-"` to disable default banner. | |
52| `--footer` | string | custom (html) footer string. Use `"-"` to disable default footer. | |
52| `--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 |
54| `--github-org` | string | restrict logins to members of this organisation | |
53| `--github-org` | string | restrict logins to members of this organisation | |
55| `--github-team` | string | restrict logins to members of any of these teams (slug), separated by a comma | |
54| `--github-team` | string | restrict logins to members of any of these teams (slug), separated by a comma | |
56| `--github-repo` | string | restrict logins to collaborators of this repository formatted as `orgname/repo` | |
55| `--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) {
302 healthCheckPaths := []string{opts.PingPath}
302 healthCheckPaths := []string{opts.PingPath}
303 healthCheckUserAgents := []string{opts.PingUserAgent}
303 healthCheckUserAgents := []string{opts.PingUserAgent}
304 if opts.GCPHealthChecks {
304 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")
305 healthCheckPaths = append(healthCheckPaths, "/liveness_check", "/readiness_check")
306 healthCheckPaths = append(healthCheckPaths, "/liveness_check", "/readiness_check")
306 healthCheckUserAgents = append(healthCheckUserAgents, "GoogleHC/1.0")
307 healthCheckUserAgents = append(healthCheckUserAgents, "GoogleHC/1.0")
307 }
308 }