doc/install/cheat_sheet.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Cheat Sheet
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 h3. Workbench: user management
  13
  14 As an Admin user, use the gear icon on the top right to visit the Users page. From there, use the 'Add new user' button to create a new user. Alternatively, visit an existing user with the 'Show' button next to the user's name. Then use the 'Admin' tab and click the 'Setup' button to activate the user, and create a virtual machine login as well as git repository for them.
  15
  16 h3. CLI setup
  17
  18 <pre>
  19 ARVADOS_API_HOST={{ site.arvados_api_host }}
  20 ARVADOS_API_TOKEN=1234567890qwertyuiopasdfghjklzxcvbnm1234567890zzzz
  21 </pre>
  22
  23 h3. CLI: Create VM
  24
  25 <pre>
  26 arv virtual_machine create --virtual-machine '{"hostname":"xxxxxxxchangeme.example.com"}'
  27 </pre>
  28
  29 h3. CLI: Activate user
  30
  31 <pre>
  32 user_uuid=xxxxxxxchangeme
  33
  34 arv user update --uuid "$user_uuid" --user '{"is_active":true}'
  35 </pre>
  36
  37 h3. User &rarr; VM
  38
  39 Give @$user_uuid@ permission to log in to @$vm_uuid@ as @$target_username@
  40
  41 <pre>
  42 user_uuid=xxxxxxxchangeme
  43 vm_uuid=xxxxxxxchangeme
  44 target_username=xxxxxxxchangeme
  45
  46 read -rd $'\000' newlink <<EOF; arv link create --link "$newlink"
  47 {
  48 "tail_uuid":"$user_uuid",
  49 "head_uuid":"$vm_uuid",
  50 "link_class":"permission",
  51 "name":"can_login",
  52 "properties":{"username":"$target_username"}
  53 }
  54 EOF
  55 </pre>
  56
  57 h3. CLI: User &rarr; repo
  58
  59 Give @$user_uuid@ permission to commit to @$repo_uuid@ as @$repo_username@
  60
  61 <pre>
  62 user_uuid=xxxxxxxchangeme
  63 repo_uuid=xxxxxxxchangeme
  64 repo_username=xxxxxxxchangeme
  65
  66 read -rd $'\000' newlink <<EOF; arv link create --link "$newlink"
  67 {
  68 "tail_uuid":"$user_uuid",
  69 "head_uuid":"$repo_uuid",
  70 "link_class":"permission",
  71 "name":"can_write",
  72 "properties":{"username":"$repo_username"}
  73 }
  74 EOF
  75 </pre>