Integrate with MaxMind out of the box

[chadwhitacre]

Closes #310.

Todo

• figure out which mmdb we want
• test with relay
• think through configuration - envvar burden okay? expose frequency?
• think through startup/install scenario
• docs: Add docs on geolocation develop#219
  • https://develop.sentry.dev/self-hosted/geolocation/
  • https://develop.sentry.dev/self-hosted/#configuration
• use bind mount instead of volume mount
• tighten up nginx config
• trick relay in empty case
• sort out reload story
• legal?
• CI? — Unfrobulate CI #768

[chadwhitacre]

https://github.com/maxmind/geoipupdate/blob/master/docker/entry.sh for reference

[BYK]

Looks pretty good so far, great job!

[chadwhitacre]

Greetings! 👋 My name is ChadBot 🤖, and I will be performing your manual continuous integration services for this PR. 🐭

Commit

c53d8a9

Test Matrix

conf	mmdb	expected
missing	missing	error
missing	present	error
bad	present	error
good	present	done
bad	missing	error
good	missing	done

Test Run

$ ./install/geoip.sh
Setting up IP address geolocation ...
Installing (empty) IP address geolocation database ... done.
IP address geolocation is not configured for updates.
See https://develop.sentry.dev/self-hosted/geolocation/ for instructions.
Error setting up IP address geolocation.
$
$
$ ./install/geoip.sh
Setting up IP address geolocation ...
IP address geolocation database already exists.
IP address geolocation is not configured for updates.
See https://develop.sentry.dev/self-hosted/geolocation/ for instructions.
Error setting up IP address geolocation.
$
$
$ touch geoip/GeoIP.conf
$
$ ./install/geoip.sh
Setting up IP address geolocation ...
IP address geolocation database already exists.
IP address geolocation is configured for updates.
Updating IP address geolocation database ...
Creating sentry_onpremise_geoipupdate_run ...
Creating sentry_onpremise_geoipupdate_run ... done
error loading configuration file /sentry/GeoIP.conf: the `EditionIDs` option is required
Error updating IP address geolocation database.
Error setting up IP address geolocation.
$
$
$ cp ~/Desktop/GeoIP.conf geoip 
$
$ ./install/geoip.sh           
Setting up IP address geolocation ...
IP address geolocation database already exists.
IP address geolocation is configured for updates.
Updating IP address geolocation database ... 
Creating sentry_onpremise_geoipupdate_run ... 
Creating sentry_onpremise_geoipupdate_run ... done
Done updating IP address geolocation database.
Done setting up IP address geolocation.
$
$
$ rm geoip/GeoIP.conf
$ rm geoip/GeoLite2-City.mmdb
$ touch geoip/GeoIP.conf
$
$ ./install/geoip.sh
Setting up IP address geolocation ...
Installing (empty) IP address geolocation database ... done.
IP address geolocation is configured for updates.
Updating IP address geolocation database ...
Creating sentry_onpremise_geoipupdate_run ...
Creating sentry_onpremise_geoipupdate_run ... done
error loading configuration file /sentry/GeoIP.conf: the `EditionIDs` option is required
Error updating IP address geolocation database.
Error setting up IP address geolocation.
$
$
$ rm geoip/GeoIP.conf 
$ rm geoip/GeoLite2-City.mmdb
$ cp ~/Desktop/GeoIP.conf geoip 
$
$ ./install/geoip.sh 
Setting up IP address geolocation ...
Installing (empty) IP address geolocation database ... done.
IP address geolocation is configured for updates.
Updating IP address geolocation database ... 
Creating sentry_onpremise_geoipupdate_run ... 
Creating sentry_onpremise_geoipupdate_run ... done
Done updating IP address geolocation database.
Done setting up IP address geolocation.
$
$
$ ls -l geoip 
total 65864
-rw-r--r--  1 chadwhitacre  staff        70 Dec 11 10:02 GeoIP.conf
-rw-r--r--  1 chadwhitacre  staff  66456088 Dec 11 10:02 GeoLite2-City.mmdb
-rw-r--r--  1 chadwhitacre  staff      1055 Dec 10 11:47 GeoLite2-City.mmdb.empty
$

Result

💃

[BYK]

I know install.sh is getting a bit unwieldy but does splitting geoip part only help much?

[chadwhitacre]

Yes. By splitting out the geoip part I am able to test it in isolation.

[BYK]

Ehh, I don't like the fact that we are doing this only for one part of the file. Let's do this only if you have a plan for refactoring the remainder of ./install.sh file without bloating the root directory with many .sh files and replicating all common things across them.

[chadwhitacre]

I don't either. :) I think we should refactor install.sh to make it more modular and therefore more testable ... and we should test it! 😁 I don't see this bloating the root directory with many .sh files, you can see here I split the subscript into an install/ directory. Yes we can and will share components between these scripts ... again, one step at a time.

[BYK]

Ehh, I don't like the fact that we are doing this only for one part of the file. Let's do this only if you have a plan for refactoring the remainder of ./install.sh file without bloating the root directory with many .sh files and replicating all common things across them.