summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDario Maiocchi <dmaiocchi@suse.com>2017-11-01 12:26:30 +0100
committerFlavio Castelli <flavio@castelli.me>2017-11-03 15:50:47 +0100
commitf5fca94677487108ad0012447f58fb229dbde63a (patch)
tree4fb165816376ebaadf2348323bf3b80082367720
parent4907902bc70d82681d6f116f4095d7b84af503ca (diff)
downloadterraform-provider-libvirt-f5fca94677487108ad0012447f58fb229dbde63a.tar
terraform-provider-libvirt-f5fca94677487108ad0012447f58fb229dbde63a.tar.gz
DOC: improve readme, separating troubleshooting.
Added also the lists of authors, and adding a troubleshooting. Libvirt-devel is required
-rw-r--r--README.md18
-rw-r--r--doc/TROUBLESHOOTING.md43
2 files changed, 48 insertions, 13 deletions
diff --git a/README.md b/README.md
index 9480f6cf..576c6710 100644
--- a/README.md
+++ b/README.md
@@ -89,24 +89,16 @@ export TF_ACC=1
go test ./...
```
-## Known Problems
+## Troubleshooting (aka you have a problem)
-* There is a [bug in libvirt](https://bugzilla.redhat.com/show_bug.cgi?id=1293804) that seems to be causing
- problems to unlink volumes. Tracked [here](https://github.com/dmacvicar/terraform-provider-libvirt/issues/6).
+Have a look at [TROUBLESHOOTING](doc/TROUBLESHOOTING.md), and feel free to add a PR if you find out something is missing.
- If you see something like:
-
- ```console
- cannot unlink file '/var/lib/libvirt/images/XXXXXXXXXXXX': Permission denied
- ```
- It is probably related and fixed in libvirt 1.3.3 (already available in openSUSE Tumbleweed).
-
-* On Ubuntu distros SELinux is enforced by qemu even if it is disabled globally, this might cause unexpected `Could not open '/var/lib/libvirt/images/<FILE_NAME>': Permission denied` errors. Double check that `security_driver = "none"` is uncommented in `/etc/libvirt/qemu.conf` and issue `sudo systemctl restart libvirt-bin` to restart the daemon.
-
-## Author
+## Authors
* Duncan Mac-Vicar P. <dmacvicar@suse.de>
+See also the list of [contributors](https://github.com/dmacvicar/terraform-provider-libvirt/graphs/contributors) who participated in this project.
+
The structure and boilerplate is inspired from the [Softlayer](https://github.com/finn-no/terraform-provider-softlayer) and [Google](https://github.com/hashicorp/terraform/tree/master/builtin/providers/google) Terraform provider sources.
## License
diff --git a/doc/TROUBLESHOOTING.md b/doc/TROUBLESHOOTING.md
new file mode 100644
index 00000000..b16b3431
--- /dev/null
+++ b/doc/TROUBLESHOOTING.md
@@ -0,0 +1,43 @@
+# Troubleshooting
+
+## You cannot build from source
+
+You run
+
+```console
+glide install
+go build
+```
+And you get:
+
+```console
+Package libvirt was not found in the pkg-config search path.
+Perhaps you should add the directory containing `libvirt.pc'
+to the PKG_CONFIG_PATH environment variable
+No package 'libvirt' found
+pkg-config: exit status 1
+```
+
+You probably need libvirt-dev(el) package installed.
+
+```console
+apt install libvirt-dev
+```
+
+## Bug in libvirt
+
+* There is a [bug in libvirt](https://bugzilla.redhat.com/show_bug.cgi?id=1293804) that seems to be causing
+ problems to unlink volumes. Tracked [here](https://github.com/dmacvicar/terraform-provider-libvirt/issues/6).
+
+ If you see something like:
+
+ ```console
+ cannot unlink file '/var/lib/libvirt/images/XXXXXXXXXXXX': Permission denied
+ ```
+ It is probably related and fixed in libvirt 1.3.3 (already available in openSUSE Tumbleweed).
+
+## Selinux on Debian distros
+
+* On Debian distros SELinux is enforced by qemu even if it is disabled globally, this might cause unexpected `Could not open '/var/lib/libvirt/images/<FILE_NAME>': Permission denied` errors. Double check that `security_driver = "none"` is uncommented in `/etc/libvirt/qemu.conf` and issue `sudo systemctl restart libvirt-bin` to restart the daemon.
+
+