1165259 - Document Heroku & supporting infrastructure in read the docs

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P1)

Description

[Ed Morley [:emorley]]

Not urgent.

Not sure where best to put these, since it's kind of infra-specific and only applies to people who have Heroku access - but would still be good to document this somewhere. I think maybe Read the docs might be a good place? (And then we can slowly deprecate https://mana.mozilla.org/wiki/display/websites/treeherder.mozilla.org)

Things to cover:
* Installing the heroku toolbelt
* Authenticating
* Adding a heroku remote to an existing repo clone (eg https://devcenter.heroku.com/articles/git#creating-a-heroku-remote)
* Some links to useful commands

Comment 1

[Ed Morley [:emorley]]

Also:
* How to connect to the Heroku RDS instance.

ie:
http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ConnectToInstance.html
(remembering to use the CA cert mentioned there; if using MySQL Workbench "Use SSL" should be set to "require" and the field to enter the path to the cert is called "SSL CA file")

...and using the host/user/password contained in the heroku env DATABASE_URL - eg:

[~/src/treeherder]$ heroku config | grep DATABASE_URL
DATABASE_URL:                 mysql://th_admin:[e-mail]/treeherder
DATABASE_URL_RO:              mysql://th_admin:[e-mail]/treeherder

Comment 2

[Ed Morley [:emorley]]

(In reply to Ed Morley [:emorley] from comment #1)
> and the field to enter the path to the
> cert is called "SSL CA file")

You can also use the CA file from the treeherder repo:
deployment/aws/combined-ca-bundle.pem

Comment 3

[Ed Morley [:emorley]]

Eugh sorry multi-post.

Instead of:

> [~/src/treeherder]$ heroku config | grep DATABASE_URL

You can also just look at the web UI:
https://dashboard.heroku.com/apps/treeherder-heroku/settings
-> "Reveal Config Vars"

Comment 4

[Ed Morley [:emorley]]

It's worth noting that on the Neroku dynos, the mysql command line client isn't available, so |./manage.py dbshell| won't work. So either connect remotely using mysqlworkbench or a mysql cli tool on your local machine, or else use |./manage.py run_sql ...| (for things that need to run against multiple project DBs).

Comment 5

[Ed Morley [:emorley]]

Looking at the FAQ page, it looks like the required mysql CLI command (if using that instead of mysqlworkbench) is (run from the treeherder src repo):

[~/src/treeherder] mysql -u th_admin -h treeherder-heroku.REDACTED.us-east-1.rds.amazonaws.com --ssl-ca=deployment/aws/combined-ca-bundle.pem --ssl-verify-server-cert

And then enter the password when prompted.

Comment 6

[Ed Morley [:emorley]]

It's also perhaps worth mentioning people can follow Heroku infra changes here:
https://devcenter.heroku.com/changelog
or via feed: https://devcenter.heroku.com/changelog

Comment 7

[Ed Morley [:emorley]]

(In reply to Ed Morley [:emorley] from comment #6)
> It's also perhaps worth mentioning people can follow Heroku infra changes
> here:

And subscribe to infra issues here:
https://status.heroku.com/

Comment 9

[Ed Morley [:emorley]]

+ things in bug 1065553 comment 5.

Comment 10

[Ed Morley [:emorley]]

Attachment: devservices-aws PR #3: Correct RDS SSL instructions

Comment 11

[Ed Morley [:emorley]]

Comment on attachment 8796985 [details] [review]
devservices-aws PR #3: Correct RDS SSL instructions

https://github.com/mozilla-platform-ops/devservices-aws/commit/66701e48dc7224bf0ec19484846c0b118fb920ef

Comment 13

[GitHub Bugzilla PR Linker]

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

Comment 14

[Ed Morley [:emorley]]

https://github.com/mozilla/treeherder/commit/6945c4c471b01fd281f74bae507233e6e3069c3a

Can be viewed at:
https://treeherder.readthedocs.io/infrastructure/architecture.html
https://treeherder.readthedocs.io/infrastructure/administration.html
https://treeherder.readthedocs.io/infrastructure/troubleshooting.html