diff --git a/README.md b/README.md index 3ab61cf2..a4e5eb2f 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,44 @@ +Terraform oVirt Provider plugin +=============================== +This plugin allows Terraform to work with the oVirt Virtual Machine management platform. + Installing Terraform oVirt plugin -================================= -Set GOPATH (usually ~/go) +--------------------------------- + +Prerequisites: + * Install Go + * Install Terraform + * Set GOPATH (usually ~/go) + +Building/Installing: ``` -brew install go -GIT_TERMINAL_PROMPT=1 go get github.com/EMSL-MSC/terraform-provider-ovirt -cd $GOPATH/src/github.com/EMSL-MSC/terraform-provider-ovirt -go build +$ go get github.com/EMSL-MSC/terraform-provider-ovirt +$ mkdir ~/.terraform.d/plugins +$ cp $GOPATH/bin/terraform-provider-ovirt ~/.terraform.d/plugins ``` -In Terraform module -=================== +Provider Usage +-------------- + +* Provider Configuration ``` -mkdir -p terraform.d/plugins/darwin_amd64 -cp $GOPATH/src/github.com/EMSL-MSC/terraform-provider-ovirt/terraform-provider-ovirt terraform.d/plugins/darwin_amd64 -terraform init +provider "ovirt" { + username = "username@profile" + url = "https://ovirt/ovirt-engine/api" + password = "Password" +} ``` + * Username - (Required) The username to access the oVirt api including the profile used + * url - (Required) The url to the api endpoint (usually the ovirt server with a path of /ovirt-engine/api) + * password - (Required) Password to access the server +* Resources + * ovirt_vm + * ovirt_disk +* Data Sources + * ovirt_disk -## Disclaimer +Disclaimer +--------- This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights. Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.