Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MaxMind GeoIP2 Anonymous IP support #5586

Merged
merged 1 commit into from
May 21, 2020
Merged

Add MaxMind GeoIP2 Anonymous IP support #5586

merged 1 commit into from
May 21, 2020

Conversation

adiov
Copy link
Contributor

@adiov adiov commented May 21, 2020

What this PR does / why we need it:

The NGINX Ingress Controller already has extensive support for many MaxMind's GeoIP2 databases. It is, however, missing support for another crucial MaxMind GeoIP2 database, the GeoIP2 Anonymous IP database. This PR adds support for it in a way that conforms to the way other MaxMind databases are supported.

For those with licence to the GeoIP2 Anonymous IP database, an additional entry to --maxmind-edition-ids can be supplied as such:

--maxmind-edition-ids="GeoLite2-City,GeoLite2-ASN,GeoIP2-Anonymous-IP"

This will trigger the existing database download and checking flow. If the database is downloaded successfully or is made available with a mounted volume, this PR exposes 3 new variables: $geoip2_is_anon, $geoip2_is_hosting_provider, and $geoip2_is_public_proxy. Those variables can then be freely used in a ConfigMap to add further functionality, such as annotating logs or blocking requests altogether.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Which issue/s this PR fixes

How Has This Been Tested?

With the new template loaded, new proxy_set_header lines to the deployment's config.yaml were added as such:

proxy_set_header X-Is-Anon $geoip2_is_anon;
proxy_set_header X-Is-Hosting-Provider $geoip2_is_hosting_provider;
proxy_set_header X-Is-Public-Proxy $geoip2_is_public_proxy;

After deployment, requests from AWS EC2 and Tor were sent to one of the Ingress endpoints. The forwarded requests were observed to have the correct header values indicating that the requests were "anonymous" or came from a hosting provider.

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 21, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @adiov!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/ingress-nginx has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @adiov. 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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 21, 2020
@adiov
Copy link
Contributor Author

adiov commented May 21, 2020

/assign @bowei

@aledbf
Copy link
Member

aledbf commented May 21, 2020

/ok-to-test

@k8s-ci-robot 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 May 21, 2020
@aledbf
Copy link
Member

aledbf commented May 21, 2020

@adiov please don't assign PRs manually

@adiov
Copy link
Contributor Author

adiov commented May 21, 2020

/retest

@aledbf
Copy link
Member

aledbf commented May 21, 2020

/lgtm
/approve

@aledbf
Copy link
Member

aledbf commented May 21, 2020

@adiov thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 21, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: adiov, aledbf

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 21, 2020
@k8s-ci-robot k8s-ci-robot merged commit 7169f3b into kubernetes:master May 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants