~andreserl/maas/lp1665143

« back to all changes in this revision

Viewing changes to docs/getting-help.rst

Merged specify_scripts_commissioning into test_api.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
************
2
 
Getting help
3
 
************
4
 
 
5
 
Where to get help
6
 
-----------------
7
 
 
8
 
The two channels you can use to get help debugging a MAAS issue are:
9
 
 
10
 
- The `Ask Ubuntu`_ website.
11
 
- The `Freenode #maas`_ IRC channel.
12
 
 
13
 
.. _Ask Ubuntu:
14
 
  http://askubuntu.com/questions/ask?tags=maas
15
 
 
16
 
.. _Freenode #maas:
17
 
  http://webchat.freenode.net/?channels=maas
18
 
 
19
 
 
20
 
Gathering debugging information
21
 
-------------------------------
22
 
 
23
 
If your question is related to a problem related to a specific MAAS installation, we encourage you to gather debugging information and make it available before you head over to Ask Ubuntu or the IRC channel.  This way, you'll have all the required information handy for people who can help you.
24
 
 
25
 
Gathering debugging information is a fully automated process that is performed with the help of `sosreport`_.
26
 
 
27
 
If your MAAS server is running Ubuntu version 14.04 (Trusty Tahr) or later, you can get sosreport from the official archives::
28
 
 
29
 
  # Install sosreport.
30
 
  sudo apt-get install -y sosreport
31
 
  # Create the report.
32
 
  sudo sosreport -o maas
33
 
 
34
 
Alternatively, if your MAAS server is running a previous Ubuntu release, you'll need to install sosreport manually::
35
 
 
36
 
  # Install git.
37
 
  sudo apt-get install -y git
38
 
  # Get the latest version of sosreport.
39
 
  git clone https://github.com/sosreport/sosreport.git /tmp/sosreport
40
 
  # Create the report.
41
 
  sudo /tmp/sosreport/sosreport -o maas
42
 
 
43
 
.. _sosreport:
44
 
  https://github.com/sosreport/sosreport
45
 
 
46
 
This will create a tarball containing MAAS' log files, MAAS' configuration files and a dump of MAAS' database.  By default, the tarball will end up in /tmp but you can change the location, see sosreport's manpage for details.  If there are things you do not wish to share publicly, feel free to edit the tarball.
47
 
 
48
 
Now, the last step is to make this file available by any means at your disposal (openly accessible FTP server, Dropbox, etc.) in order for the people who will help you to be able to get their hands on it.
49