[ARVADOS] updated: 051efbd3d843baa690b334e57fd09fad6a908bb9

Git user git at public.curoverse.com
Tue Nov 1 13:37:45 EDT 2016 

Summary of changes:
 doc/_config.yml                                    |  4 ++--
 doc/api/execution.html.textile.liquid              | 25 ++++++++++++++++++++++
 doc/api/methods/api_clients.html.textile.liquid    |  2 ++
 .../methods/authorized_keys.html.textile.liquid    |  2 ++
 doc/api/methods/collections.html.textile.liquid    |  2 ++
 .../methods/container_requests.html.textile.liquid |  2 ++
 doc/api/methods/containers.html.textile.liquid     |  2 ++
 doc/api/methods/groups.html.textile.liquid         |  2 ++
 doc/api/methods/humans.html.textile.liquid         |  2 ++
 doc/api/methods/job_tasks.html.textile.liquid      |  2 ++
 doc/api/methods/jobs.html.textile.liquid           |  2 ++
 doc/api/methods/keep_disks.html.textile.liquid     |  5 +++++
 doc/api/methods/keep_services.html.textile.liquid  | 10 ++++-----
 doc/api/methods/links.html.textile.liquid          |  3 +++
 doc/api/methods/logs.html.textile.liquid           |  2 ++
 doc/api/methods/nodes.html.textile.liquid          |  2 ++
 .../methods/pipeline_instances.html.textile.liquid |  2 ++
 .../methods/pipeline_templates.html.textile.liquid |  2 ++
 doc/api/methods/repositories.html.textile.liquid   |  2 ++
 doc/api/methods/specimens.html.textile.liquid      |  2 ++
 doc/api/methods/traits.html.textile.liquid         |  2 ++
 doc/api/methods/users.html.textile.liquid          |  2 ++
 .../methods/virtual_machines.html.textile.liquid   |  2 ++
 doc/api/methods/workflows.html.textile.liquid      |  2 ++
 doc/api/tokens.html.textile.liquid                 | 21 ++++++++++++++++++
 25 files changed, 99 insertions(+), 7 deletions(-)
 create mode 100644 doc/api/execution.html.textile.liquid
 create mode 100644 doc/api/tokens.html.textile.liquid

       via  051efbd3d843baa690b334e57fd09fad6a908bb9 (commit)
      from  3c2fee34ad8f668f5cf9001d6b7d605965ec28bb (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.


commit 051efbd3d843baa690b334e57fd09fad6a908bb9
Author: Peter Amstutz <peter.amstutz at curoverse.com>
Date:   Tue Nov 1 13:37:41 2016 -0400

    10346: Added UUID type to each resource.  Some formatting cleanups.

diff --git a/doc/_config.yml b/doc/_config.yml
index 4f9e200..2f66fcd 100644
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -109,11 +109,11 @@ navbar:
       - api/permission-model.html.textile.liquid
       - api/execution.html.textile.liquid
     - Permission and authentication:
-      - api/methods/users.html.textile.liquid
-      - api/methods/groups.html.textile.liquid
       - api/methods/api_client_authorizations.html.textile.liquid
       - api/methods/api_clients.html.textile.liquid
       - api/methods/authorized_keys.html.textile.liquid
+      - api/methods/groups.html.textile.liquid
+      - api/methods/users.html.textile.liquid
     - System resources:
       - api/methods/keep_services.html.textile.liquid
       - api/methods/links.html.textile.liquid
diff --git a/doc/api/execution.html.textile.liquid b/doc/api/execution.html.textile.liquid
new file mode 100644
index 0000000..ade3f5c
--- /dev/null
+++ b/doc/api/execution.html.textile.liquid
@@ -0,0 +1,25 @@
+---
+layout: default
+navsection: api
+title: Computing with Crunch
+...
+
+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.
+
+h2. Container API
+
+Note: although the preferred API for Aravdos going forward, the Container API may not yet be available on all installations.
+
+# To submit work, create a "container request":{{site.baseurl}}/api/methods/container_requests.html in the @Committed@ state.
+# 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.
+# 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).
+# 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.
+# When the container associated with the container request is completed, the container request will go into the @Final@ state.
+# Retrieve the container object; the @output@ field contains the portable data hash of collection with the output files of the container.
+
+h2. Job API (deprecated)
+
+# 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.
+# The dispatcher process will notice a new job in @Queued@ state and attempt to allocate nodes to run the job.
+# The job executes.
+# Retrieve the @output@ field with the portable data hash of the collection with the output files of the job.
diff --git a/doc/api/methods/api_clients.html.textile.liquid b/doc/api/methods/api_clients.html.textile.liquid
index fa4d9d2..3c668bd 100644
--- a/doc/api/methods/api_clients.html.textile.liquid
+++ b/doc/api/methods/api_clients.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/api_clients@
 
+UUID type: @ozdt8@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/authorized_keys.html.textile.liquid b/doc/api/methods/authorized_keys.html.textile.liquid
index 62072ac..079d150 100644
--- a/doc/api/methods/authorized_keys.html.textile.liquid
+++ b/doc/api/methods/authorized_keys.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/authorized_keys@
 
+UUID type: @fngyi@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/collections.html.textile.liquid b/doc/api/methods/collections.html.textile.liquid
index 5662b31..563e20e 100644
--- a/doc/api/methods/collections.html.textile.liquid
+++ b/doc/api/methods/collections.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/collections@
 
+UUID type: @4zz18@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Methods
diff --git a/doc/api/methods/container_requests.html.textile.liquid b/doc/api/methods/container_requests.html.textile.liquid
index 2f7eac3..a024527 100644
--- a/doc/api/methods/container_requests.html.textile.liquid
+++ b/doc/api/methods/container_requests.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/container_requests@
 
+UUID type: @xvhdp@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/containers.html.textile.liquid b/doc/api/methods/containers.html.textile.liquid
index 0ef1cf9..145b1d6 100644
--- a/doc/api/methods/containers.html.textile.liquid
+++ b/doc/api/methods/containers.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/containers@
 
+UUID type: @dz642@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/groups.html.textile.liquid b/doc/api/methods/groups.html.textile.liquid
index b229266..3e4a252 100644
--- a/doc/api/methods/groups.html.textile.liquid
+++ b/doc/api/methods/groups.html.textile.liquid
@@ -11,6 +11,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/groups@
 
+UUID type: @j7d0g@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/humans.html.textile.liquid b/doc/api/methods/humans.html.textile.liquid
index 2077938..0d4b2cc 100644
--- a/doc/api/methods/humans.html.textile.liquid
+++ b/doc/api/methods/humans.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/humans@
 
+UUID type: @7a9it@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/job_tasks.html.textile.liquid b/doc/api/methods/job_tasks.html.textile.liquid
index a343d54..6d031c9 100644
--- a/doc/api/methods/job_tasks.html.textile.liquid
+++ b/doc/api/methods/job_tasks.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/job_tasks@
 
+UUID type: @ot0gb@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/jobs.html.textile.liquid b/doc/api/methods/jobs.html.textile.liquid
index 0c93eb6..4779fb9 100644
--- a/doc/api/methods/jobs.html.textile.liquid
+++ b/doc/api/methods/jobs.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/jobs@
 
+UUID type: @8i9sb@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/keep_disks.html.textile.liquid b/doc/api/methods/keep_disks.html.textile.liquid
index 37c7b14..7cec243 100644
--- a/doc/api/methods/keep_disks.html.textile.liquid
+++ b/doc/api/methods/keep_disks.html.textile.liquid
@@ -10,8 +10,12 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/keep_disks@
 
+UUID type: @penuu@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
+Obsoleted by "keep_services":{{site.baseurl}}/api/methods/keep_services.html
+
 h2. Resource
 
 Each KeepDisk has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
@@ -31,6 +35,7 @@ table(table table-bordered table-condensed).
 |keep_service_uuid|string|||
 
 h2. Methods
+
 h3. create
 
 Create a new KeepDisk.
diff --git a/doc/api/methods/keep_services.html.textile.liquid b/doc/api/methods/keep_services.html.textile.liquid
index 5fa8817..97ed7d8 100644
--- a/doc/api/methods/keep_services.html.textile.liquid
+++ b/doc/api/methods/keep_services.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/keep_services@
 
+UUID type: @bi6l4@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
@@ -27,12 +29,10 @@ h2. Methods
 
 h3. accessible
 
-Get a list of keep services that are accessible to the requesting client.  This
-is context-sensitive, for example providing the list of actual Keep servers
-when inside the cluster, but providing a proxy service if client contacts
-Arvados from outside the cluster.
+Get a list of keep services that are accessible to the requesting client.  Unlike @list@, this is context-sensitive based on the requester, for example providing the list of actual Keep servers when inside the cluster, but providing a proxy service if client contacts Arvados from outside the cluster.
 
-Takes no arguments.
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
 
 h3. create
 
diff --git a/doc/api/methods/links.html.textile.liquid b/doc/api/methods/links.html.textile.liquid
index 003456c..99205be 100644
--- a/doc/api/methods/links.html.textile.liquid
+++ b/doc/api/methods/links.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/links@
 
+UUID type: @o0j2j@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
@@ -79,6 +81,7 @@ table(table table-bordered table-condensed).
 
 
 h2. Methods
+
 h3. create
 
 Create a new Link.
diff --git a/doc/api/methods/logs.html.textile.liquid b/doc/api/methods/logs.html.textile.liquid
index 58ce979..e878071 100644
--- a/doc/api/methods/logs.html.textile.liquid
+++ b/doc/api/methods/logs.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/logs@
 
+UUID type: @57u5n@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Creation
diff --git a/doc/api/methods/nodes.html.textile.liquid b/doc/api/methods/nodes.html.textile.liquid
index 4ccbd99..e5cb80a 100644
--- a/doc/api/methods/nodes.html.textile.liquid
+++ b/doc/api/methods/nodes.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/nodes@
 
+UUID type: @7ekkf@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/pipeline_instances.html.textile.liquid b/doc/api/methods/pipeline_instances.html.textile.liquid
index 97bf59a..cacdaca 100644
--- a/doc/api/methods/pipeline_instances.html.textile.liquid
+++ b/doc/api/methods/pipeline_instances.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_instances@
 
+UUID type: @d1hrv@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/pipeline_templates.html.textile.liquid b/doc/api/methods/pipeline_templates.html.textile.liquid
index d44ee7b..672b274 100644
--- a/doc/api/methods/pipeline_templates.html.textile.liquid
+++ b/doc/api/methods/pipeline_templates.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_templates@
 
+UUID type: @p5p6p@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/repositories.html.textile.liquid b/doc/api/methods/repositories.html.textile.liquid
index d2dcdc0..d745703 100644
--- a/doc/api/methods/repositories.html.textile.liquid
+++ b/doc/api/methods/repositories.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/repositories@
 
+UUID type: @s0uqq@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/specimens.html.textile.liquid b/doc/api/methods/specimens.html.textile.liquid
index 79ef479..55a7b0c 100644
--- a/doc/api/methods/specimens.html.textile.liquid
+++ b/doc/api/methods/specimens.html.textile.liquid
@@ -8,6 +8,8 @@ title: "specimens"
 
 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
 
+UUID type: @j58dm@
+
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/specimens@
 
 Required arguments are displayed in %{background:#ccffcc}green%.
diff --git a/doc/api/methods/traits.html.textile.liquid b/doc/api/methods/traits.html.textile.liquid
index 0f99772..9ed0df2 100644
--- a/doc/api/methods/traits.html.textile.liquid
+++ b/doc/api/methods/traits.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/traits@
 
+UUID type: @q1cn2@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/users.html.textile.liquid b/doc/api/methods/users.html.textile.liquid
index 81e49c0..25eac28 100644
--- a/doc/api/methods/users.html.textile.liquid
+++ b/doc/api/methods/users.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/users@
 
+UUID type: @tpzed@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/virtual_machines.html.textile.liquid b/doc/api/methods/virtual_machines.html.textile.liquid
index 7384659..b353325 100644
--- a/doc/api/methods/virtual_machines.html.textile.liquid
+++ b/doc/api/methods/virtual_machines.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/virtual_machines@
 
+UUID type: @2x53u@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/methods/workflows.html.textile.liquid b/doc/api/methods/workflows.html.textile.liquid
index 16755ce..17fb351 100644
--- a/doc/api/methods/workflows.html.textile.liquid
+++ b/doc/api/methods/workflows.html.textile.liquid
@@ -10,6 +10,8 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/workflows@
 
+UUID type: @7fd4e@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. Resource
diff --git a/doc/api/tokens.html.textile.liquid b/doc/api/tokens.html.textile.liquid
new file mode 100644
index 0000000..458c41b
--- /dev/null
+++ b/doc/api/tokens.html.textile.liquid
@@ -0,0 +1,21 @@
+---
+layout: default
+navsection: api
+title: API Authorization
+...
+
+All requests to the API server must have an API token.  API tokens can be issued by going though the login flow, or created via the API.  At this time, only browser based applications can perform login from email/password.  Command line applications and services must have an API token provided via the @ARVADOS_API_TOKEN@ environment variable or configuration file.
+
+h2. Browser login
+
+Browser based applications can perform log in via the following flow:
+
+# The web application presents a "login" link to @/login@ on the API server with a @return_to@ parameter provided in the query portion of the URL.  For example @https://{{ site.arvados_api_host }}/login?return_to=XXX@ , where  @return_to=XXX@ is the URL of the login page for the web application.
+# The "login" link takes the browser to the login page (this may involve several redirects)
+# The user logs in.  API server authenticates the user and issues a new API token.
+# The browser is redirected to the login page URL provided in @return_to=XXX@ with the addition of @?api_token=xxxxapitokenxxxx at .
+# The web application gets the login request with the included API token.
+
+h2. Creating tokens via the API
+
+Use the @create@ method of the "API client authorizations":{{site.baseurl}}/api/methods/api_client_authorizations.html resource.

-----------------------------------------------------------------------


hooks/post-receive
--

More information about the arvados-commits mailing list