summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/bugs.rst
blob: f9d9bc8670c319c063a07f6741f766ef29ddc4f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
.. _reporting_bugs:

Reporting Bugs
**************

Logs
====

To aid in debugging collecting the necessary logs, first run the
`collect-logs` subcommand to produce a tarfile that you can easily upload
to aid in intial debugging of your issue:

.. code-block:: shell-session

  $ cloud-init collect-logs
  Wrote /home/ubuntu/cloud-init.tar.gz

If your cloud-init does not have the  `collect-logs` subcommand, then please
manually collect the base log files by doing the following:

.. code-block:: shell-session

  $ dmesg > dmesg.txt
  $ sudo journalctl -o short-precise > journal.txt
  $ sudo tar -cvf cloud-init.tar dmesg.txt journal.txt /run/cloud-init \
      /var/log/cloud-init.log /var/log/cloud-init-output.log

Reporting
=========

Bugs for upstream cloud-init are tracked using Launchpad. To file a bug,
`create a Launchpad account`_, login, and then
`report an upstream cloud-init bug`_.

If your bug is for a specific distro using cloud-init, please first consider
reporting it with the upstream distro or confirm that it still occurs
with the latest upstream cloud-init code. See below for details on specific
distro reporting.

Distro Specific Issues
======================

For issues specific to your distro please use one of the following distro
specific reporting mechanisms:

Ubuntu
------

To report a bug on Ubuntu use the `ubuntu-bug` command to automatically
collect the necessary logs and file a bug on Launchpad:

.. code-block:: shell-session

  $ ubuntu-bug cloud-init

If that does not work or is not an option, please collect the logs using the
commands above and then report the bug on the `Ubuntu bug tracker`_. Make sure
to attach your collected logs!

Debian
------

To file a bug against the Debian package fo cloud-init please use the
`Debian bug tracker`_ to file against 'Package: cloud-init'. See the
`Debian bug reporting wiki`_ wiki page for more details.

Red Hat, CentOS, & Fedora
-------------------------

To file a bug against the Red Hat or Fedora packages of cloud-init please use
the `Red Hat bugzilla`_.

SUSE & openSUSE
---------------

To file a bug against the SuSE packages of cloud-init please use the
`SUSE bugzilla`_.

Arch
----

To file a bug against the Arch package of cloud-init please use the
`Arch bugs`_. See the `Arch bug reporting wiki`_ for more details.

.. _create a Launchpad account: https://help.launchpad.net/YourAccount/NewAccount
.. _report an upstream cloud-init bug: https://bugs.launchpad.net/cloud-init/+filebug
.. _Ubuntu bug tracker: https://bugs.launchpad.net/ubuntu/+source/cloud-init/+filebug
.. _Debian bug tracker: https://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=cloud-init;dist=unstable
.. _Debian bug reporting wiki: https://www.debian.org/Bugs/Reporting
.. _Red Hat bugzilla: https://bugzilla.redhat.com/
.. _SUSE bugzilla: https://bugzilla.suse.com/index.cgi
.. _Arch bugs: https://bugs.archlinux.org/
.. _Arch bug reporting wiki: https://wiki.archlinux.org/index.php/Bug_reporting_guidelines

.. vi: textwidth=79