doc/install/create-standard-objects.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Create standard objects
   5
   6 ...
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 In these steps we use the Arvados CLI tools on the <strong>shell server</strong> to create a few Arvados objects. The CLI tools require an ARVADOS_API_TOKEN environment variable with a valid admin token. If you haven't already done so, set that up as shown in the "API token guide":../user/reference/api-tokens.html.
  14
  15 h3. Arvados repository
  16
  17 Here we create a repository object which will be used to set up a hosted clone of the arvados repository on this cluster.
  18
  19 <notextile>
  20 <pre><code>~$ <span class="userinput">prefix=`arv --format=uuid user current | cut -d- -f1`</span>
  21 ~$ <span class="userinput">echo "Site prefix is '$prefix'"</span>
  22 ~$ <span class="userinput">all_users_group_uuid="$prefix-j7d0g-fffffffffffffff"</span>
  23 ~$ <span class="userinput">repo_uuid=`arv --format=uuid repository create --repository "{\"owner_uuid\":\"$prefix-tpzed-000000000000000\", \"name\":\"arvados\"}"`</span>
  24 ~$ <span class="userinput">echo "Arvados repository uuid is '$repo_uuid'"</span>
  25 </code></pre></notextile>
  26
  27 Create a link object to make the repository object readable by the "All users" group, and therefore by every active user. This makes it possible for users to run the bundled Crunch scripts by specifying @"script_version":"master","repository":"arvados"@ rather than pulling the Arvados source tree into their own repositories.
  28
  29 <notextile>
  30 <pre><code>~$ <span class="userinput">read -rd $'\000' newlink &lt;&lt;EOF; arv link create --link "$newlink"</span>
  31 <span class="userinput">{
  32  "tail_uuid":"$all_users_group_uuid",
  33  "head_uuid":"$repo_uuid",
  34  "link_class":"permission",
  35  "name":"can_read"
  36 }
  37 EOF</span>
  38 </code></pre></notextile>
  39
  40 In a couple of minutes, your arvados-git-sync cron job will create an empty repository on your git server. Seed it with the real arvados repository. If your git credential helpers were configured correctly when you "set up your shell server":install-shell-server.html, the "git push" command will use your API token instead of prompting you for a username and password.
  41
  42 <notextile>
  43 <pre><code>~$ <span class="userinput">cd /tmp</span>
  44 /tmp$ <span class="userinput">git clone --bare https://github.com/curoverse/arvados.git</span>
  45 /tmp <span class="userinput">git --git-dir arvados.git push https://git.<b>uuid_prefix.your.domain</b>/arvados.git '*:*'</span>
  46 </code></pre>
  47 </notextile>
  48
  49 If you did not set up a HTTPS service, you can push to <code>git@git.uuid_prefix.your.domain:arvados.git</code> using your SSH key, or by logging in to your git server and using sudo.
  50
  51 <notextile>
  52 <pre><code>gitserver:~$ <span class="userinput">sudo -u git -i bash</span>
  53 git@gitserver:~$ <span class="userinput">git clone --bare https://github.com/curoverse/arvados.git /tmp/arvados.git</span>
  54 git@gitserver:~$ <span class="userinput">cd /tmp/arvados.git</span>
  55 git@gitserver:/tmp/arvados.git$ <span class="userinput">gitolite push /var/lib/arvados/git/repositories/<b>your_arvados_repo_uuid</b>.git '*:*'</span>
  56 </code></pre>
  57 </notextile>
  58
  59 h3. Default project for docker images
  60
  61 Here we create a default project for the standard Arvados Docker images, and give all users read access to it. The project is owned by the system user.
  62
  63 <notextile>
  64 <pre><code>~$ <span class="userinput">project_uuid=`arv --format=uuid group create --group "{\"owner_uuid\":\"$prefix-tpzed-000000000000000\", \"name\":\"Arvados Standard Docker Images\"}"`</span>
  65 ~$ <span class="userinput">echo "Arvados project uuid is '$project_uuid'"</span>
  66 ~$ <span class="userinput">read -rd $'\000' newlink &lt;&lt;EOF; arv link create --link "$newlink"</span>
  67 <span class="userinput">{
  68  "tail_uuid":"$all_users_group_uuid",
  69  "head_uuid":"$project_uuid",
  70  "link_class":"permission",
  71  "name":"can_read"
  72 }
  73 EOF</span>
  74 </code></pre></notextile>
  75
  76 h3. Download and tag the latest arvados/jobs docker image
  77
  78 The @arvados-cwl-runner@ needs access to an arvados/jobs image that is tagged as 'latest'. The following command downloads the latest arvados/jobs image from Docker Hub, loads it into Keep, and tags it as 'latest'.
  79
  80 <notextile>
  81 <pre><code>~$ <span class="userinput">arv-keepdocker --pull arvados/jobs latest</span>
  82 </code></pre></notextile>
  83
  84 If the image needs to be downloaded from Docker Hub, the command can take a few minutes to complete, depending on available network bandwidth.