aboutsummaryrefslogtreecommitdiff
path: root/website/docs/index.html.markdown
diff options
context:
space:
mode:
authorFlavio Castelli <fcastelli@suse.com>2017-07-27 22:40:19 +0200
committerFlavio Castelli <flavio@castelli.me>2017-07-31 16:56:15 +0200
commit78341e5971cac8f23e7c36321180a71ee6816131 (patch)
treec45fa77a37b5cdfbe838c8e1945f6b25440a43bc /website/docs/index.html.markdown
parent3db390a4fbe0601af4f33f4c0f6a1c243f2119d5 (diff)
downloadterraform-provider-libvirt-78341e5971cac8f23e7c36321180a71ee6816131.tar
terraform-provider-libvirt-78341e5971cac8f23e7c36321180a71ee6816131.tar.gz
Improve documentation
Change the documentation to fit with the upstream one. Signed-off-by: Flavio Castelli <fcastelli@suse.com>
Diffstat (limited to 'website/docs/index.html.markdown')
-rw-r--r--website/docs/index.html.markdown50
1 files changed, 50 insertions, 0 deletions
diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown
new file mode 100644
index 00000000..6dc0cfe1
--- /dev/null
+++ b/website/docs/index.html.markdown
@@ -0,0 +1,50 @@
+---
+layout: "libvirt"
+page_title: "Provider: libvirt"
+sidebar_current: "docs-libvirt-index"
+description: |-
+ The Libvirt provider is used to interact with Linux KVM/libvirt hypervisors. The provider needs to be configured with the proper connection information before it can be used.
+---
+
+# Libvirt Provider
+
+The Libvirt provider is used to interact with Linux
+[libvirt](https://libvirt.org) hypervisors.
+
+The provider needs to be configured with the proper connection information
+before it can be used.
+
+~> **Note:** while libvirt can be used with several types of hypervisors, this
+provider focuses on [KVM](http://libvirt.org/drvqemu.html). Other drivers may not be
+working and haven't been tested.
+
+## Example Usage
+
+```hcl
+# Configure the Libvirt provider
+provider "libvirt" {
+ uri = "qemu:///system"
+}
+
+# Create a new domain
+resource "libvirt_domain" "test1" {
+ ...
+}
+```
+
+## Configuration Reference
+
+The following keys can be used to configure the provider.
+
+* `uri` - (Required) The [connection URI](https://libvirt.org/uri.html) used
+ to connect to the libvirt host.
+
+## Environment variables
+
+The libvirt connection URI can also be specified with the `LIBVIRT_DEFAULT_URI`
+shell environment variable.
+
+```hcl
+$ export LIBVIRT_DEFAULT_URI="qemu+ssh://root@192.168.1.100/system"
+$ terraform plan
+```