X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/68b018141677e7147fe2b52a88561dc7d57e6d79..8dccf76ea830057d433b07c40bc2c1294891ea39:/doc/user/tutorials/tutorial-submit-job.html.textile.liquid diff --git a/doc/user/tutorials/tutorial-submit-job.html.textile.liquid b/doc/user/tutorials/tutorial-submit-job.html.textile.liquid index a77273763d..b17f951e74 100644 --- a/doc/user/tutorials/tutorial-submit-job.html.textile.liquid +++ b/doc/user/tutorials/tutorial-submit-job.html.textile.liquid @@ -13,55 +13,18 @@ This tutorial uses @$USER@ to denote your username. Replace @$USER@ with your u Also, this tutorial uses the @tutorial@ arvados repository created in "Adding a new arvados repository":add-new-repository.html as the example repository. -h2. Clone arvados repository +h2. Clone Arvados repository -All Crunch scripts are managed through the Git revision control system. Before you start using Git, you should do some basic configuration (you only need to do this the first time): - - -
~$ git config --global user.name "Your Name"
-~$ git config --global user.email $USER@example.com
-
- -On the Arvados Workbench, click on the dropdown menu icon in the upper right corner of the top navigation menu to access the user settings menu, and click on the menu item *Manage account* to go to the account management page. - -On the *Manage account* page, you will see *Repositories* panel. In this panel, you should see the @$USER/tutorial@ repository listed in the *name* column. Next to *name* is the column *URL*. Copy the *URL* value associated with your repository. This should look like https://git.{{ site.arvados_api_host }}/$USER/tutorial.git. Alternatively, you can use git@git.{{ site.arvados_api_host }}:$USER/tutorial.git - -Next, on the Arvados virtual machine, clone your Git repository: - - -
~$ cd $HOME # (or wherever you want to install)
-~$ git clone https://git.{{ site.arvados_api_host }}/$USER/tutorial.git
-Cloning into 'tutorial'...
-
- -This will create a Git repository in the directory called @tutorial@ in your home directory. Say yes when prompted to continue with connection. -Ignore any warning that you are cloning an empty repository. - -*Note:* If you are prompted for username and password when you try to git clone using this command, you may first need to update your git configuration. Execute the following commands to update your git configuration. - - -
-~$ git config 'credential.https://git.{{ site.arvados_api_host }}/.username' none
-~$ git config 'credential.https://git.{{ site.arvados_api_host }}/.helper' '!cred(){ cat >/dev/null; if [ "$1" = get ]; then echo password=$ARVADOS_API_TOKEN; fi; };cred'
-
-
- -{% include 'notebox_begin' %} -For more information about using Git, try - -notextile.
$ man gittutorial
- -or *"search Google for Git tutorials":http://google.com/#q=git+tutorial*. -{% include 'notebox_end' %} +Please clone the *tutorial* repository using the instructions from "Working with Arvados git repository":git-arvados-guide.html, if you have not yet cloned already. h2. Creating a Crunch script -Start by entering the @tutorial@ directory created by @git clone@. Next create a subdirectory called @crunch_scripts@ and change to that directory: +Start by entering the @tutorial@ directory created by @git clone@. Next, create a subdirectory called @crunch_scripts@ and change to that directory: -
~$ cd $USER
-~/$USER$ mkdir crunch_scripts
-~/$USER$ cd crunch_scripts
+
>~$ cd tutorial
+~/tutorial$ mkdir crunch_scripts
+~/tutorial$ cd crunch_scripts
Next, using @nano@ or your favorite Unix text editor, create a new file called @hash.py@ in the @crunch_scripts@ directory. @@ -83,7 +46,7 @@ notextile.
~/tutorial/crunch_scripts$ git add
 Next, commit your changes.  All staged changes are recorded into the local git repository:
 
 
-
~/tutorial/crunch_scripts$ git commit -m"my first script"
+
~/tutorial/crunch_scripts$ git commit -m "my first script"
 [master (root-commit) 27fd88b] my first script
  1 file changed, 45 insertions(+)
  create mode 100755 crunch_scripts/hash.py
@@ -113,7 +76,7 @@ In the editor, enter the following template: {% code 'tutorial_submit_job' as javascript %} -* @"repository"@ is the name of a git repository to search for the script version. You can access a list of available git repositories on the Arvados Workbench in the *Manage account* page using the top navigation menu icon. +* @"repository"@ is the name of a git repository to search for the script version. You can access a list of available git repositories on the Arvados Workbench in the *Repositories* page using the top navigation menu icon. * @"script_version"@ specifies the version of the script that you wish to run. This can be in the form of an explicit Git revision hash, a tag, or a branch (in which case it will use the HEAD of the specified branch). Arvados logs the script version that was used in the run, enabling you to go back and re-run any past job with the guarantee that the exact same code will be used as was used in the previous run. * @"script"@ specifies the filename of the script to run. Crunch expects to find this in the @crunch_scripts/@ subdirectory of the Git repository. * @"runtime_constraints"@ describes the runtime environment required to run the job. These are described in the "job record schema":{{site.baseurl}}/api/schema/Job.html