1069249 - Docs: Explain how to view the DB inside a Vagrant instance

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P3)

Description

[Ed Morley [:emorley]]

Mauro introduced me to:
python manage.py dbshell

We should add that to:
https://treeherder-service.readthedocs.org/en/latest/installation.html

Ideally we'd also list steps to interact with the DB visually (eg MySQL Workbench, Remote MySQL Viewer) - Mauro is this possible currently? Can we open some ports up on the VM and connect to it from the host?

Comment 1

[Mauro Doglio [:mdoglio]]

Yes, mysql is bound to 0.0.0.0 here https://github.com/mozilla/treeherder-service/blob/master/puppet/files/mysql/my.cnf#L47
so it's accessible from your host machine on local.treeherder.mozilla.org:3306

Comment 2

[Ed Morley [:emorley]]

Ah that's great :-)

We can add that to RTD too.

Comment 3

[Ed Morley [:emorley]]

We should also document connecting to the treeherder prod DB for debugging, a la:

22:49	camd	jeads: sorry to bug ya again. whenever I try ``mysql -u th_user" I get:
22:49	camd	ERROR 2002 (HY000): Can't connect to local MySQL server through socket '/var/lib/mysql/mysql.sock' (2)
22:49	jeads	camd: are you connected to vpn? and are you specifying the correct host name for mysql to connect to?
22:50	camd	ahh crud. that's it... trying...
22:50	jeads	camd: your command should look like this
22:50	jeads	mysql -h treeherder-ro-vip.metrics.scl3.mozilla.com -u th_user -p
22:51	camd	jeads: that was it. thanks!~

Comment 4

[Ed Morley [:emorley]]

Some thing to consider that I hadn't thought of, is that if the user already has MySQL running on the host, they'd need to map 3306 in the VM to a different port on the host, using:
https://docs.vagrantup.com/v2/networking/forwarded_ports.html

Though there's an auto_correct feature that we could enable. (Which outputs adjusted port info to the console on vagrant up).

Comment 5

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/treeherder/pull/3814

Comment 6

[Treeherder GitHub Bugbot]

Commit pushed to master at https://github.com/mozilla/treeherder

https://github.com/mozilla/treeherder/commit/ca2f8515a3cfc264d08de1cba1a3b30ce36a4e91
Bug 1069249 - Explain how to view DB inside a Vagrant VM