[Branch,~linaro-validation/lava-scheduler/trunk] Rev 212: update usage doc

Message ID 20120920155110.18813.43233.launchpad@ackee.canonical.com
State Accepted
Headers show

Commit Message

Andy Doan Sept. 20, 2012, 3:51 p.m.
------------------------------------------------------------
revno: 212
committer: Andy Doan <andy.doan@linaro.org>
branch nick: lava-scheduler
timestamp: Thu 2012-09-20 10:49:55 -0500
message:
  update usage doc
  
  This gets it back on par with what was in the wiki at:
  
    https://wiki.linaro.org/Platform/Validation/LAVA/SubmittingTests
  
  Next step will be to kill the wiki page and point here.
modified:
  doc/usage.rst


--
lp:lava-scheduler
https://code.launchpad.net/~linaro-validation/lava-scheduler/trunk

You are subscribed to branch lp:lava-scheduler.
To unsubscribe from this branch go to https://code.launchpad.net/~linaro-validation/lava-scheduler/trunk/+edit-subscription

Patch

=== modified file 'doc/usage.rst'
--- doc/usage.rst	2011-11-16 21:02:31 +0000
+++ doc/usage.rst	2012-09-20 15:49:55 +0000
@@ -9,26 +9,44 @@ 
 
 Generating a Token
 ==================
-Before a job can be submitted, a token must be generated.  Logged in as
-a user with *lava_scheduler_app | test job | Can add test job* and
-*linaro_django_xmlrpc | auth token | Can add auth token* permissions
-enabled, select *API* from the menu at the top, then *Authentication
+Before a job can be submitted, a token must be generated. You can create a
+token from the *API* menu at the top, then select *Authentication
 Tokens*. From this page, click on *Create a new token*.  Once you have
 created at least one token, you can click *Display this token* to show
 it.  The token string can be copied from the browser for pasting into a
 tool later, or saved to a file.
 
-Using lava-scheduler-tool
-=========================
-LAVA Scheduler Tool is actually a plugin to LAVA Tool.  It can be
-installed from debian packages, source, or pypi in the same way
-described for installing the scheduler in the installation section.
+*NOTE*: Your user account may need the proper permission to allow it to
+submit jobs. The user account will need two permissions::
+
+  lava_scheduler_app | test job | Can add test job
+  linaro_django_xmlrpc | auth token | Can add auth token
+
+added to it via the Django admin panel.
+
+Configuring lava-scheduler-tool
+===============================
+There are 3 ways to install the tool::
+
+  # easiest
+  sudo add-apt-repository ppa:linaro-maintainers/tools
+  sudo apt-get update
+  sudo apt-get install lava-scheduler-tool
+
+  # from pypi
+  pip install lava-scheduler-tool
+
+  # from source for development with:
+  bzr branch lp:lava-scheduler-tool
+  cd lava-scheduler-tool ; ./setup.py develop
+
+You'll probaly also want the lava-dashboard-tool installed as well. This can
+be done using the same steps as outlined above.
 
 To submit jobs using the scheduler, you should first set up the server
-to which you will be submitting jobs.
-With lava-scheduler-tool installed, run ::
+to which you will be submitting jobs::
 
- $ lava-tool auth-add https://user@example.com/lava-server/RPC2/
+ $ lava-tool auth-add https://user@example.com/RPC2/
 
 In this example, *user@example.com* should be replaced with your userid
 and webserver.  Using https is *highly* recommended since it will ensure
@@ -41,11 +59,19 @@ 
 to a file and use the --token-file parameter to specify the file
 containing your token.
 
-Once the auth-add step is complete, you can submit jobs by running ::
-
- $ lava-tool submit-job http://user@example.com/lava-server/RPC2/
- jobfile.json
-
-.. todo::
- Add link to information about constructing a job - lava-project might
- be a better place to put usage information in general
+Using lava-scheduler-tool
+=========================
+
+The first thing you may want to do is create a bundle stream in the LAVA
+dashboard where you'll put your bundles. This is done with::
+
+  lava-dashboard-tool make-stream --dashboard-url http://example.com/RPC2/ /anonymous/USERNAME/
+
+Next you'll need a job file. You can read about an example job file `here`_
+
+.. _here: http://lava.readthedocs.org/en/latest/qemu-deploy.html
+
+You can now submit jobs by running ::
+
+ $ lava-scheduler-tool submit-job http://user@example.com/RPC2/ jobfile.json
+