Allow Requests to be Mirrored to different backends #4379

diazjf · 2019-07-30T20:44:22Z

Add a feature which allows traffic to be mirrored to additional backends. This is useful for testing how requests will behave on different "test" backends.

See https://nginx.org/en/docs/http/ngx_http_mirror_module.html

k8s-ci-robot · 2019-07-30T20:44:30Z

Hi @diazjf. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

aledbf · 2019-07-30T20:53:36Z

/ok-to-test

aledbf · 2019-07-30T21:02:15Z

docs/user-guide/nginx-configuration/annotations.md

+nginx.ingress.kubernetes.io/mirror-request-body: "off"
+```
+
+For more information on the mirror module see https://nginx.org/en/docs/http/ngx_http_mirror_module.html


Please add a note mentioning the side effects of using this feature against a slow backend
https://alex.dzyoba.com/blog/nginx-mirror/

aledbf · 2019-07-30T21:02:45Z

@diazjf what's the behavior if the ingress rule contains multiple paths?

diazjf · 2019-07-30T21:09:27Z

@diazjf what's the behavior if the ingress rule contains multiple paths?

If there are multiple paths within an ingress rule, then the traffic will be mirrored to the mirror-uri from all paths. Maybe I can specify in the docs that ideally it should be applied to one path at a time?

^ @aledbf

diazjf · 2019-07-31T15:50:19Z

/retest

codecov-io · 2019-07-31T22:12:31Z

Codecov Report

Merging #4379 into master will increase coverage by 2.49%.
The diff coverage is 77.77%.

@@            Coverage Diff             @@
##           master    #4379      +/-   ##
==========================================
+ Coverage   58.63%   61.13%   +2.49%     
==========================================
  Files          88       89       +1     
  Lines        6569     7150     +581     
==========================================
+ Hits         3852     4371     +519     
- Misses       2288     2331      +43     
- Partials      429      448      +19

Impacted Files	Coverage Δ
internal/ingress/types.go	`0% <ø> (ø)`	⬆️
internal/ingress/types_equals.go	`17.91% <0%> (-0.22%)`	⬇️
internal/ingress/annotations/mirror/main.go	`100% <100%> (ø)`
internal/ingress/annotations/annotations.go	`81.42% <100%> (+0.26%)`	⬆️
internal/ingress/controller/controller.go	`46.82% <100%> (+0.06%)`	⬆️
internal/ingress/controller/config/config.go	`98.64% <0%> (+0.07%)`	⬆️
internal/ingress/metric/collectors/process.go	`90.42% <0%> (+2.12%)`	⬆️
internal/ingress/controller/template/template.go	`85.92% <0%> (+2.43%)`	⬆️
internal/watch/file_watcher.go	`84.61% <0%> (+3.84%)`	⬆️
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 292aca7...386486e. Read the comment docs.

Add a feature which allows traffic to be mirrored to additional backends. This is useful for testing how requests will behave on different "test" backends. See https://nginx.org/en/docs/http/ngx_http_mirror_module.html

diazjf · 2019-08-01T17:40:23Z

/retest

diazjf · 2019-08-01T17:46:45Z

^ @aledbf ready to review 👍

aledbf · 2019-08-06T21:36:29Z

/approve

aledbf · 2019-08-06T21:36:55Z

@diazjf my only doubt with this feature is why not just use the canary annotations?

diazjf · 2019-08-08T07:32:01Z

Canary does provide some of the same benefits in an easy to use way. Great post https://www.elvinefendi.com/2018/11/25/canary-deployment-with-ingress-nginx.html by @ElvinEfendi

The benefits I see for mirror are as follows:

Easier migration to Kubernetes from NGINX config using mirror
Exact mirror of all requests, where canary will split the traffic by weight (correct me if I'm wrong), this is good because we can test production traffic on other environments.

^ @aledbf

aledbf · 2019-08-08T12:28:28Z

Exact mirror of all requests,

Yes, is not the same thing.

aledbf · 2019-08-08T12:28:35Z

/approve

ElvinEfendi · 2019-08-11T19:17:41Z

/lgtm

k8s-ci-robot · 2019-08-11T19:17:52Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, diazjf, ElvinEfendi

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [ElvinEfendi,aledbf]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

diazjf · 2019-08-13T19:45:05Z

/retest

aledbf · 2019-08-14T00:21:11Z

/retest

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 30, 2019

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 30, 2019

k8s-ci-robot requested review from aledbf and ElvinEfendi July 30, 2019 20:44

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 30, 2019

aledbf reviewed Jul 30, 2019

View reviewed changes

diazjf force-pushed the mirror branch from eb8e503 to c41a37d Compare July 30, 2019 21:18

dcherniv mentioned this pull request Jul 30, 2019

ingress-nginx 0.25 fails to reload backend #4380

Closed

diazjf force-pushed the mirror branch 2 times, most recently from 04b9101 to dca2ecd Compare July 31, 2019 22:05

diazjf force-pushed the mirror branch 2 times, most recently from 2c2f6c5 to 1792a62 Compare August 1, 2019 03:35

Allow Requests to be Mirrored to different backends

386486e

Add a feature which allows traffic to be mirrored to additional backends. This is useful for testing how requests will behave on different "test" backends. See https://nginx.org/en/docs/http/ngx_http_mirror_module.html

diazjf force-pushed the mirror branch from 1792a62 to 386486e Compare August 1, 2019 16:54

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 6, 2019

aledbf assigned ElvinEfendi Aug 6, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 11, 2019

k8s-ci-robot merged commit adef152 into kubernetes:master Aug 14, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow Requests to be Mirrored to different backends #4379

Allow Requests to be Mirrored to different backends #4379

diazjf commented Jul 30, 2019

k8s-ci-robot commented Jul 30, 2019

aledbf commented Jul 30, 2019

aledbf Jul 30, 2019

diazjf Jul 30, 2019

aledbf commented Jul 30, 2019

diazjf commented Jul 30, 2019

diazjf commented Jul 31, 2019

codecov-io commented Jul 31, 2019 •

edited

Loading

diazjf commented Aug 1, 2019

diazjf commented Aug 1, 2019

aledbf commented Aug 6, 2019

aledbf commented Aug 6, 2019

diazjf commented Aug 8, 2019

aledbf commented Aug 8, 2019

aledbf commented Aug 8, 2019

ElvinEfendi commented Aug 11, 2019

k8s-ci-robot commented Aug 11, 2019

diazjf commented Aug 13, 2019

aledbf commented Aug 14, 2019

Allow Requests to be Mirrored to different backends #4379

Allow Requests to be Mirrored to different backends #4379

Conversation

diazjf commented Jul 30, 2019

k8s-ci-robot commented Jul 30, 2019

aledbf commented Jul 30, 2019

aledbf Jul 30, 2019

Choose a reason for hiding this comment

diazjf Jul 30, 2019

Choose a reason for hiding this comment

aledbf commented Jul 30, 2019

diazjf commented Jul 30, 2019

diazjf commented Jul 31, 2019

codecov-io commented Jul 31, 2019 • edited Loading

Codecov Report

diazjf commented Aug 1, 2019

diazjf commented Aug 1, 2019

aledbf commented Aug 6, 2019

aledbf commented Aug 6, 2019

diazjf commented Aug 8, 2019

aledbf commented Aug 8, 2019

aledbf commented Aug 8, 2019

ElvinEfendi commented Aug 11, 2019

k8s-ci-robot commented Aug 11, 2019

diazjf commented Aug 13, 2019

aledbf commented Aug 14, 2019

codecov-io commented Jul 31, 2019 •

edited

Loading