7995: Add "dry run" note.
[arvados.git] / doc / install / cheat_sheet.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Cheat Sheet
5 ...
6
7 h3. Workbench: user management
8
9 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.
10
11 h3. CLI setup
12
13 <pre>
14 ARVADOS_API_HOST={{ site.arvados_api_host }}
15 ARVADOS_API_TOKEN=1234567890qwertyuiopasdfghjklzxcvbnm1234567890zzzz
16 </pre>
17
18 h3. CLI: Create VM
19
20 <pre>
21 arv virtual_machine create --virtual-machine '{"hostname":"xxxxxxxchangeme.example.com"}'
22 </pre>
23
24 h3. CLI: Activate user
25
26 <pre>
27 user_uuid=xxxxxxxchangeme
28
29 arv user update --uuid "$user_uuid" --user '{"is_active":true}'
30 </pre>
31
32 h3. User &rarr; VM
33
34 Give @$user_uuid@ permission to log in to @$vm_uuid@ as @$target_username@
35
36 <pre>
37 user_uuid=xxxxxxxchangeme
38 vm_uuid=xxxxxxxchangeme
39 target_username=xxxxxxxchangeme
40
41 read -rd $'\000' newlink <<EOF; arv link create --link "$newlink"
42 {
43 "tail_uuid":"$user_uuid",
44 "head_uuid":"$vm_uuid",
45 "link_class":"permission",
46 "name":"can_login",
47 "properties":{"username":"$target_username"}
48 }
49 EOF
50 </pre>
51
52 h3. CLI: User &rarr; repo
53
54 Give @$user_uuid@ permission to commit to @$repo_uuid@ as @$repo_username@
55
56 <pre>
57 user_uuid=xxxxxxxchangeme
58 repo_uuid=xxxxxxxchangeme
59 repo_username=xxxxxxxchangeme
60
61 read -rd $'\000' newlink <<EOF; arv link create --link "$newlink"
62 {
63 "tail_uuid":"$user_uuid",
64 "head_uuid":"$repo_uuid",
65 "link_class":"permission",
66 "name":"can_write",
67 "properties":{"username":"$repo_username"}
68 }
69 EOF
70 </pre>