Story #3044

[Documentation] Improve documentation for authoring crunch scripts

Added by Tom Clegg about 6 years ago. Updated over 3 years ago.

Status:
Closed
Priority:
Normal
Assigned To:
-
Category:
Documentation
Target version:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
2.0

Description

This goes in the developer docs, logically between "introductory materials" and "API reference".

Acceptance criteria

  • Describe how Arvados uses git repositories, and the layout of those repositories
    • it expects crunch scripts to be in the crunch_scripts directory, and to be executable
  • Describe generally how a Crunch script is invoked and the environment it runs in
    • API server and token
    • Availability of SDK (depends on docker image)
    • Current job and task
    • Keep mount point
    • Other important environment variables
  • Describe what a Crunch script must do to be considered successful:
    • update task record with success=true and output
    • exit 0
    • exit 111 → temporary failure, try again <= N times
  • Introduce the concept of tasks and sequencing, and illustrate how they're useful for separating work.
    • sequence vs. qsequence
  • Explain the output collation process.
    • task can provide either a manifest [fragment], or a Keep locator of one

Related issues

Related to Arvados - Bug #4440: [Documentation] "Writing a Crunch script" is mysteriousClosed11/05/2014

Related to Arvados - Feature #4579: [Documentation] Run-command docs should remind user how & why to exit non-zero on failure.New11/18/2014

History

#1 Updated by Tom Clegg about 6 years ago

  • Target version set to Arvados Future Sprints

#2 Updated by Radhika Chippada about 6 years ago

  • Subject changed from Improve documentation for authoring crunch scripts to [Documentation] Improve documentation for authoring crunch scripts
  • Category set to Documentation

#3 Updated by Brett Smith about 6 years ago

  • Description updated (diff)

#4 Updated by Tom Clegg about 6 years ago

  • Target version changed from Arvados Future Sprints to 2014-08-27 Sprint

#5 Updated by Tom Clegg about 6 years ago

  • Description updated (diff)

#6 Updated by Brett Smith almost 6 years ago

  • Assigned To set to Brett Smith

#7 Updated by Tom Clegg almost 6 years ago

  • Target version changed from 2014-08-27 Sprint to Arvados Future Sprints

#8 Updated by Tom Clegg over 5 years ago

  • Story points changed from 1.0 to 2.0

#9 Updated by Tom Morris almost 4 years ago

  • Assigned To changed from Brett Smith to Tom Morris

#10 Updated by Tom Morris over 3 years ago

  • Status changed from New to Closed
  • Assigned To deleted (Tom Morris)
  • Target version deleted (Arvados Future Sprints)

Also available in: Atom PDF