Граф коммитов

148 Коммитов

Автор SHA1 Сообщение Дата
William Lachance bce0bef92e Bug 1231421 - Add hint about UI-only treeherder to installation docs 2015-12-09 17:10:36 -05:00
William Lachance 1c25789c10 Update docs title 2015-12-09 11:02:55 -05:00
Ed Morley 5f9a57ef21 Bug 1225597 - Docs: Use anonymous links to avoid build warnings
Fixes:
common_tasks.rst:2: WARNING: Duplicate explicit target name: "stage".
common_tasks.rst:2: WARNING: Duplicate explicit target name: "production".

http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#anonymous-hyperlinks
2015-11-25 13:35:25 +00:00
Ed Morley 6df3aa4ac3 Bug 1225597 - Docs: Make local hawk credentials section easier to find
Also remove the duplication between the two pages, by having the
submitting data section not mention requesting credentials at all, and
leave that to the common tasks page instead.
2015-11-25 13:35:25 +00:00
Ed Morley ed8498710c Bug 1221536 - Docs: Emphasise starting the worker before ingest_push
If the worker is not running, any `apply_async()` calls are silently
thrown away, due to `ingest_push`'s use of `CELERY_ALWAYS_EAGER` and:
https://github.com/celery/celery/issues/2910

As such, running the worker after ingest_push doesn't help (since the
rabbitmq queues are empty) and so if people are interested in perf/log
data, then they must start the worker first instead.
2015-11-04 16:18:14 +00:00
Ed Morley f059f88d85 Bug 1205758 - Run `grunt build` as part of the stage/prod deploy
In update.py, the line outputting revision.txt has to be moved later,
since the `dist/` directory won't exist until grunt build has run. In
addition, since `grunt build` removes the entire `dist/` directory, we
no longer need to manually remove *.gz.

We use the `--production` options for both `npm install` and
`grunt build`, so that the `devDependencies` in package.json are
ignored, and we only install/load the ones listed under `dependencies`
in package.json - since that's all that is required for the build.

We have to use `./node_modules/.bin/grunt` rather than `grunt`, since
grunt-cli is not installed globally on the treeherder admin machine for
greater isolation between stage and production.
2015-10-31 16:06:08 +00:00
Ed Morley 27941c32d9 Bug 1206381 - Add npm-shrinkwrap.json to pin grunt build dependencies
Whilst the packages listed in package.json are pinned to exact versions,
they will have their own dependencies, which may be specified via
version ranges. In order to make production/local behaviour more
deterministic, these can be pinned too, using `npm shrinkwrap`.
However the stock shrinkwrap command has a few deficiencies, so we're
using a wrapper around it:
https://github.com/uber/npm-shrinkwrap

Note: Only packages listed under `dependencies` will be shrinkwrapped,
not those under `devDependencies`. This is because using the `--dev`
option (which would include the dev packages in npm-shrinkwrap.json)
means there would then be no way to way to exclude the dev packages when
installing in production.

For more information about shrinkwrap in general, see:
https://docs.npmjs.com/cli/shrinkwrap
http://tilomitra.com/why-you-should-use-npm-shrinkwrap/
https://nodejs.org/en/blog/npm/managing-node-js-dependencies-with-shrinkwrap/
2015-10-28 09:33:17 +00:00
Mauro Doglio c876849a3c Bug 1193836 - Remove mention to init_master_db from docs 2015-10-27 11:19:18 +00:00
Ed Morley 2c89b988f6 Bug 1217496 - Docs: Mention Hawk auth requires correct system clock
Since if submitters' clocks are out of sync, Hawk auth will fail.
2015-10-23 13:39:08 +01:00
Ed Morley 32863c77a4 Bug 1216247 - Document how to create Hawk credentials locally
And also:
* Explain the process for request/approval on stage/prod
* Remove the unnecessary export_project_credentials step in the
"add a new repository" section, since Treeherder's ETL no longer uses
credentials.json.
2015-10-20 11:18:17 +01:00
William Lachance a164383961 Bug 1212931 - Update the client documentation to describe hawk auth
Since the old auth "TreeherderAuth" system is now deprecated.
2015-10-19 12:50:52 -04:00
Ed Morley 5bd8132ee2 Bug 1213847 - Deprecate passing the auth object to the client's methods
Since with the new per-user Hawk credentials, the same auth object can
be used for the whole session, so should just be passed when
instantiating TreeherderClient.
2015-10-12 16:11:19 +01:00
Ed Morley 8ae9071901 Bug 1197186 - Move settings to treeherder/config/
Since they're not specific to the Django app 'webapp'.

Whilst we're there, the local & example settings files have been
renamed. In the future I'd like to combine settings_local.example.py
with puppet/files/treeherder/local.vagrant.py, but I'll do that in
another bug.
2015-10-08 19:59:46 +01:00
Ed Morley 364f635917 Bug 1198536 - Remove job.build_url since it's unused 2015-10-05 20:41:34 +01:00
Ed Morley 40c90e3365 Bug 1192957 - Docs: Explain the Python import style and how to run isort
In the future, the new "Code Style" page will also be used to explain
other styles/linters used in the project, eg JavaScript / ESlint.
2015-10-02 17:55:28 +01:00
Cameron Dawson 4a4efd6e76 Bug 1205906 - Adds JSON schema for text_log_summary artifacts 2015-10-02 09:36:15 -07:00
Ed Morley a31174407a Bug 1207613 - Remove the dist/ directory from master
Heroku now generates it on deploy, and for stage/prod we generate it
fresh on the stage/prod branch and force push each time. As such, we
have no need for the directory on master, and by removing it we avoid
confusion when new contributors grep the repo.

As an added bonus, the stage/prod deploy script should fail if the dist
directory is missing, so the grunt build cannot be forgotten prior to
deploying. (Currently if it's forgotten, we end up deploying the ancient
dist directory from master that was last updated prior to us switching
to the new deployment strategy.)
2015-10-02 11:55:54 +01:00
Cameron Dawson 7510eb98d9 Bug 1169320 - Documentation for pulse ingestion
This documentation instructs a user on how to setup their local
machine to ingest data from existing exchanges as well as posting
to their own to test their jobs.
2015-10-01 15:50:12 -07:00
Ed Morley 7241b58c5d Docs: Minor cleanup to the "Building the docs" section 2015-09-30 16:04:34 +01:00
Ed Morley 90ba77e596 Bug 1192801 - Remove per-file MPL boilerplate since it's unnecessary
The MPL 2.0 terms state that as long as a LICENSE file is present, the
per-file header text is not required. See "Exhibit A" at the end of:
https://www.mozilla.org/MPL/2.0/
2015-08-18 23:32:11 +01:00
Ed Morley 26acccf944 Bug 1193775 - Document how to test UI-only changes using GitHub pages 2015-08-15 11:13:06 +01:00
Ed Morley ac8e41e5e9 Bug 1178300 - Docs: Formatting and readability tweaks to setup docs 2015-08-11 16:00:49 +01:00
Ed Morley fb9f0af43c Bug 1178300 - Docs: Move the hosts file step into the Vagrant section
Since it can be performed whilst `vagrant up` is running, and whilst
modifying the hosts file is not necessary for running the tests, most
people will still want to do it.
2015-08-11 15:55:27 +01:00
Ed Morley ed77e4e69c Bug 1178300 - Docs: Add Windows-specific setup help
Fixes #684.
2015-08-11 14:56:12 +01:00
Ed Morley 106c0bcca4 Bug 1178300 - Docs: Add a prerequisites section which links to Bootcamp
Also mention the need for Git to be installed & link to Git website.
2015-08-11 14:56:11 +01:00
Ed Morley 3e248c5bf8 Bug 1178300 - Docs: Move Vagrant troubleshooting steps to their own page
Since most people will not require them, and the list is growing quite
large.
2015-08-11 14:56:10 +01:00
Ed Morley 85a6cfdec3 Bug 1165929 - Docs: Add instructions on how to build the docs locally 2015-08-11 12:41:54 +01:00
Ed Morley e68c2403da Bug 1191602 - Docs: s/Vagrant instance/Vagrant VM/ 2015-08-11 12:14:35 +01:00
Ed Morley a36c7f47da Bug 1191602 - Docs: Clarify which commands should be run inside the VM
The shell prompts for each command example already mention vagrant, but
this can still be missed, so make the distinction extra clear.
2015-08-11 11:14:29 +01:00
Ed Morley 1c00ccfcc7 Bug 1192661 - Clean up Python import order
Created using |isort -p tests -rc .| and a couple of manual tweaks.

The order is:
* futures
* std library
* third party packages
* local imports
* relative local imports
...with each group ordered with "import x" before "from x import y", and
then alphabetically.
2015-08-10 18:33:49 +01:00
Ed Morley a34c805d40 Bug 1191738 - Fix code block markup in submitting_data.rst
It was using Markdown rather than reStructuredText syntax.
2015-08-06 11:47:52 +01:00
Ed Morley 4b8624c5a8 Bug 1190894 - Vagrant: Make it clearer that vagrant v1.5+ is required
We require 1.5+ due to the use of just the box name, without URL.

This is now mentioned in the setup docs, plus fails more obviously
during |vagrant up|, thanks to:
http://docs.vagrantup.com/v2/vagrantfile/vagrant_version.html
2015-08-05 13:23:02 +01:00
William Lachance f072d29380 Clarify ingest_push
* Reinforce push must be < 4 hours old
* s/mozilla-central/mozilla-inbound/ (better example, since mozilla-inbound is more likely to have pushes less than 4 hours old)
2015-08-04 13:00:54 -04:00
Ed Morley a49c98b180 Bug 1186357 - Remove the deprecated objectstore endpoint
Since bug 1140349, the objectstore endpoint has been deprecated, and
performs the same function as the jobs endpoint. Now that there are no
remaining submitters to it, let's remove it.
2015-07-30 13:19:30 +01:00
Cameron Dawson 00cfe6643d Bug 1140349 - Remove the objectstore code
After the previous commit, the Objectstore is effectively "dead code".
So this commit removes all the dead code after anything left over in
the Objectstore has been drained and added to the DB.
2015-07-21 14:13:21 -07:00
Mauro Doglio b9881f937c Bug 1183575 - Create a requests auth backend for 2-legged oauth 2015-07-20 16:12:33 +02:00
Jonathan French b6b0e1ac45 Bug 1184247 - Add celerybeat-schedule removal to Troubleshooting 2015-07-16 09:36:13 -04:00
MikeLing 5035bd6540 Bug 1184135-Fix "Validating Javascript" eslint steps 2015-07-16 08:59:31 +08:00
William Lachance 658927bdf7 Bug 1183367 - Add a grunt target to run eslint on JS frontend 2015-07-14 13:40:18 -04:00
Cameron Dawson 51cc8f6a27 Bug 1182299 - Support custom log name param in logslice
This adds the ability to specify a custom log name and have the log
viewer use the ``logname`` param of the ``text_log_summary`` to get the
right log.

This also improves the error message returned by the /logslice/ API if a
log name is used that is not found.
2015-07-13 09:18:24 -07:00
Ed Morley 7e7975d675 Bug 1179214 - Docs: Remove reference to a revision's 'files' property
Since it's been removed from the client/API.
2015-07-09 15:31:41 +01:00
Vaibhav Agrawal e693397b38 Bug 1180967 - Add a note that node.js should be in treeherder ui docs. 2015-07-06 16:55:54 -07:00
William Lachance 5e6ac65659 Clarify documentation for ingest_push
The revision specified for ingest_push was just an example
2015-06-30 17:17:58 -04:00
Ed Morley 58813b0c51 Bug 1169916 - Stop using Cython to build the log parser
Since it only speeds up parsing by a few percent of total runtime, and
is therefore not worth the added complexity for deployment and local
hack-test-debug cycles when working on the log parser.

The .gitignore and update.py entries will be removed in a later commit,
once the stage/prod src directories have been cleaned up.
2015-06-30 14:51:57 +01:00
Ed Morley e9efcf8584 Bug 1178224 - Remove the unused result_set_artifact table 2015-06-30 01:39:45 +01:00
William Lachance 1c129a5cc6 Bug 1175935 - Add a section on "retrieving data" to docs
Currently documents the swagger interface to the REST API and the python
client API.
2015-06-19 13:44:04 -04:00
Ed Morley bf4c7c05ff Bug 1151803 - Serve the UI using gunicorn/WhiteNoise instead of Apache
In order that we can serve the UI on Heroku, we wrap the Django wsgi app
with WhiteNoise, so both the UI and API requests are served by gunicorn.

In the Vagrant environment, Apache has been removed and Varnish instead
now proxies all requests to gunicorn/Django runserver directly, without
Apache as a go-between.

The UI on production will not be affected by this commit, since the
Apache config there will still intercept requests for the UI assets
rather than proxying them to gunicorn.

It's worth noting too, that we're not able to make use of WhiteNoise's
automatic Django GZip/caching support since that assumes we are using
Django templates and referring to resources using {% static "foo.css" %}

However, we can sub-class WhiteNoise (or more specifically the
DjangoWhiteNoise class) and override the is_immutable_file() method to
add caching support at a later date:
http://whitenoise.evans.io/en/latest/base.html#caching-headers

Documentation for WhiteNoise can be found at:
http://whitenoise.evans.io/
2015-06-19 15:56:23 +01:00
Ed Morley c3efa7c400 Bug 1151803 - Docs: Clarify the UI build/dist explanation & steps
Explains the reasoning behind the dist directory, and separates out the
"updating the dist directory" and "testing the dist directory" steps.
2015-06-19 15:08:44 +01:00
Ed Morley 15911f5d77 Bug 1151803 - Docs: Remove instructions on how to restart varnish
The Varnish config uses |return (pass)| unconditionally, so never
caches anything, so there's no need to suggest restarting it after
making changes to the UI.
2015-06-19 13:20:32 +01:00
Cameron Dawson f92ba96cb2 Bug 1174192 - Allow specifying tier for a job from the client 2015-06-18 08:46:47 -07:00