10346: Added UUID type to each resource. Some formatting cleanups.
[arvados.git] / doc / api / execution.html.textile.liquid
1 ---
2 layout: default
3 navsection: api
4 title: Computing with Crunch
5 ...
6
7 Crunch is the name for the Arvados system for managing computation.  It provides an abstract API to various clouds and HPC resource allocation and scheduling systems.
8
9 h2. Container API
10
11 Note: although the preferred API for Aravdos going forward, the Container API may not yet be available on all installations.
12
13 # To submit work, create a "container request":{{site.baseurl}}/api/methods/container_requests.html in the @Committed@ state.
14 # The system will fufill the container request by creating a "Container object":{{site.baseurl}}/api/methods/containers.html or, if the same request has been submitted in the past, reusing an existing container.  This will be assigned to the @container_uuid@ field.
15 # The dispatcher process will notice a new container in @Queued@ state and submit a container executor to the underyling work queuing system (such as SLURM).
16 # The container executes.  Upon termination the container goes into the  @Complete@ state.  If the container execution was interrupted or lost due to system failure, it will go into the @Cancelled@ state.
17 # When the container associated with the container request is completed, the container request will go into the @Final@ state.
18 # Retrieve the container object; the @output@ field contains the portable data hash of collection with the output files of the container.
19
20 h2. Job API (deprecated)
21
22 # To submit work, create a "job":{{site.baseurl}}/api/methods/job.html .  If the same job has been submitted in the past, it will return an existing job in @Completed@ state.
23 # The dispatcher process will notice a new job in @Queued@ state and attempt to allocate nodes to run the job.
24 # The job executes.
25 # Retrieve the @output@ field with the portable data hash of the collection with the output files of the job.