doc/install/cheat_sheet.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: admin
   4 title: User management at the CLI
   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 Note this bypasses user agreements checks, and does not set up the user with a default git repository or VM login.
  32
  33 <pre>
  34 user_uuid=xxxxxxxchangeme
  35
  36 arv user update --uuid "$user_uuid" --user '{"is_active":true}'
  37 </pre>
  38
  39 h3. CLI: Setup a user
  40
  41 This creates a default git repository and VM login.
  42
  43 <pre>
  44 user_uuid=xxxxxxxchangeme
  45
  46 arv user setup --uuid "$user_uuid"
  47 </pre>
  48
  49 h3. CLI: Deactivate user
  50
  51 <pre>
  52 user_uuid=xxxxxxxchangeme
  53
  54 arv user unsetup --uuid "$user_uuid"
  55 </pre>
  56
  57 h3. User &rarr; VM
  58
  59 Give @$user_uuid@ permission to log in to @$vm_uuid@ as @$target_username@
  60
  61 <pre>
  62 user_uuid=xxxxxxxchangeme
  63 vm_uuid=xxxxxxxchangeme
  64 target_username=xxxxxxxchangeme
  65
  66 read -rd $'\000' newlink <<EOF; arv link create --link "$newlink"
  67 {
  68 "tail_uuid":"$user_uuid",
  69 "head_uuid":"$vm_uuid",
  70 "link_class":"permission",
  71 "name":"can_login",
  72 "properties":{"username":"$target_username"}
  73 }
  74 EOF
  75 </pre>
  76
  77 h3. CLI: User &rarr; repo
  78
  79 Give @$user_uuid@ permission to commit to @$repo_uuid@ as @$repo_username@
  80
  81 <pre>
  82 user_uuid=xxxxxxxchangeme
  83 repo_uuid=xxxxxxxchangeme
  84 repo_username=xxxxxxxchangeme
  85
  86 read -rd $'\000' newlink <<EOF; arv link create --link "$newlink"
  87 {
  88 "tail_uuid":"$user_uuid",
  89 "head_uuid":"$repo_uuid",
  90 "link_class":"permission",
  91 "name":"can_write",
  92 "properties":{"username":"$repo_username"}
  93 }
  94 EOF
  95 </pre>