19215: Add install page mentioning diagnostics tool.
[arvados.git] / doc / install / diagnostics.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Cluster diagnostics tool
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 The @diagnostics@ subcommand of @arvados-client@ performs a variety of checks to help confirm that your Arvados installation has been properly configured.  It is extremely helpful to validate that your install is successful.
14
15 Here is an example of it in action:
16
17 <pre>
18 root@api:~$ apt-get install arvados-client
19 root@api:~$ export ARVADOS_API_HOST=ClusterID.example.com
20 root@api:~$ export ARVADOS_API_TOKEN=YourSytemRootTokenHere
21 root@api:~$ arvados-client diagnostics -external-client
22 INFO      10: getting discovery document from https://ClusterID.example.com/discovery/v1/apis/arvados/v1/rest
23 INFO      20: getting exported config from https://ClusterID.example.com/arvados/v1/config
24 INFO      30: getting current user record
25 INFO      40: connecting to service endpoint https://keep.ClusterID.example.com/
26 INFO      41: connecting to service endpoint https://*.collections.ClusterID.example.com/
27 INFO      42: connecting to service endpoint https://download.ClusterID.example.com/
28 INFO      43: connecting to service endpoint wss://ws.ClusterID.example.com/websocket
29 INFO      44: connecting to service endpoint https://workbench.ClusterID.example.com/
30 INFO      45: connecting to service endpoint https://workbench2.ClusterID.example.com/
31 INFO      50: checking CORS headers at https://ClusterID.example.com/
32 INFO      51: checking CORS headers at https://keep.ClusterID.example.com/d41d8cd98f00b204e9800998ecf8427e+0
33 INFO      52: checking CORS headers at https://download.ClusterID.example.com/
34 INFO      60: checking internal/external client detection
35 INFO      61: reading+writing via keep service at https://keep.ClusterID.example.com:443/
36 INFO      80: finding/creating "scratch area for diagnostics" project
37 INFO      90: creating temporary collection
38 INFO     100: uploading file via webdav
39 INFO     110: checking WebDAV ExternalURL wildcard (https://*.collections.ClusterID.example.com/)
40 INFO     120: downloading from webdav (https://d41d8cd98f00b204e9800998ecf8427e-0.collections.ClusterID.example.com/foo)
41 INFO     121: downloading from webdav (https://d41d8cd98f00b204e9800998ecf8427e-0.collections.ClusterID.example.com/sha256:feb5d9fea6a5e9606aa995e879d862b825965ba48de054caab5ef356dc6b3412.tar)
42 INFO     122: downloading from webdav (https://download.ClusterID.example.com/c=d41d8cd98f00b204e9800998ecf8427e+0/_/foo)
43 INFO     123: downloading from webdav (https://download.ClusterID.example.com/c=d41d8cd98f00b204e9800998ecf8427e+0/_/sha256:feb5d9fea6a5e9606aa995e879d862b825965ba48de054caab5ef356dc6b3412.tar)
44 INFO     124: downloading from webdav (https://a15a27cbc1c7d2d4a0d9e02529aaec7e-128.collections.ClusterID.example.com/sha256:feb5d9fea6a5e9606aa995e879d862b825965ba48de054caab5ef356dc6b3412.tar)
45 INFO     125: downloading from webdav (https://download.ClusterID.example.com/c=ce8i5-4zz18-bkfvq2skqqf78xd/_/sha256:feb5d9fea6a5e9606aa995e879d862b825965ba48de054caab5ef356dc6b3412.tar)
46 INFO     130: getting list of virtual machines
47 INFO     140: getting workbench1 webshell page
48 INFO     150: connecting to webshell service
49 INFO     160: running a container
50 INFO      ... container request submitted, waiting up to 10m for container to run
51 INFO    9990: deleting temporary collection
52 INFO    --- no errors ---
53 </pre>