Merge branch '1694-user-agreement'

[arvados.git] / doc / user / tutorials / tutorial-job-debug.textile

diff --git a/doc/user/tutorials/tutorial-job-debug.textile b/doc/user/tutorials/tutorial-job-debug.textile
index ebf194e388365a57026524d7382769d89e5de779..9ea454cde6b759a879596a2ac8d27a1c8071bb72 100644 (file)
--- a/doc/user/tutorials/tutorial-job-debug.textile
+++ b/doc/user/tutorials/tutorial-job-debug.textile
@@ -1,11 +1,12 @@
 ---
 layout: default
 navsection: userguide
-title: "Debug a Crunch script"
-navorder: 114
+navmenu: Tutorials
+title: "Debugging a Crunch script"
+navorder: 14
 ---
 
-h1. Tutorial: Debug a Crunch script
+h1. Tutorial: Debugging a Crunch script
 
 To test changes to a script by running a job, the change must be pushed into @git@, the job queued asynchronously, and the actual execution may be run on any compute server.  As a result, debugging a script can be difficult and time consuming.  This tutorial demonstrates using @arv-crunch-job@ to run your job in your local VM.  This avoids the job queue and allows you to execute the script from your uncomitted git tree.
 
@@ -138,4 +139,18 @@ hello world
 </code></pre>
 </notextile>
 
+h3. Location of temporary files
+
+Crunch job tasks are supplied with @TASK_WORK@ and @JOB_WORK@ environment variables, to be used as scratch space.  When running in local development mode using @arv-crunch-job@, Crunch sets these variables to point to directory called @crunch-job-{USERID}@ in @TMPDIR@ (or @/tmp@ if @TMPDIR@ is not set).
+
+* Set @TMPDIR@ to @/scratch@ to make Crunch use a directory like @/scratch/crunch-job-{USERID}/@ for temporary space.
+
+* Set @CRUNCH_TMP@ to @/scratch/foo@ to make Crunch use @/scratch/foo/@ for temporary space (omitting the default @crunch-job-{USERID}@ leaf name)
+
+h3. Testing job scripts without SDKs and Keep access
+
+Read and write data to @/tmp/@ instead of Keep. This only works with the Python SDK.
+
+notextile. <pre><code>$ <span class="userinput">export KEEP_LOCAL_STORE=/tmp</span></code></pre>
+
 Next, "parallel tasks.":tutorial-parallel.html