Add support for allocations

Author: stbenjam

Makefile

@@ -11,7 +11,7 @@ endif
 default: fmt lint build
 
 build:
-	go build -ldflags "${LDFLAGS}"
+	go build -ldflags "${LDFLAGS}" -tags "${TAGS}"
 
 install: default
 	mkdir -p ${TERRAFORM_PLUGINS}
@@ -27,10 +27,10 @@ lint: tools
 	go run golang.org/x/lint/golint -set_exit_status ./ironic .
 
 test:
-	go test -v ./ironic
+	go test -tags "${TAGS}" -v ./ironic
 
 acceptance:
-	TF_ACC=true go test -v ./ironic/...
+	TF_ACC=true go test -tags "acceptance" -v ./ironic/...
 
 clean:
 	rm -f terraform-provider-ironic

README.md

@@ -4,16 +4,29 @@
 
 This is a terraform provider that lets you provision baremetal servers managed by Ironic.
 
-# Usage
+## Provider
 
-Example:
+Currently the provider only supports standalone noauth Ironic.  At a
+minimum, the Ironic endpoint URL must be specified. The user may also
+optionally specify an API microversion.
 
 ```terraform
 provider "ironic" {
-  "url" = "http://localhost:6385/v1"
-  "microversion" = "1.50"
+  url = "http://localhost:6385/v1"
+  microversion = "1.52"
 }
+```
+
+## Resources
+
+This provider currently implements a number of native Ironic resources,
+described below.
 
+### Nodes
+
+A node describes a hardware resource.
+
+```terraform
 resource "ironic_node_v1" "openshift-master-0" {
   name = "openshift-master-0"
   target_provision_state = "active"
@@ -50,6 +63,43 @@ resource "ironic_node_v1" "openshift-master-0" {
 }
 ```
 
+## Ports
+
+Ports may be specified as part of the node resource, or as a separate `ironic_port_v1`
+declaration.
+
+```terraform
+resource "ironic_port_v1" "openshift-master-0-port-0" {
+  node_uuid   = "${ironic_node_v1.openshift-master-0.id}"
+  pxe_enabled = true
+  address     = "00:bb:4a:d0:5e:38"
+}
+```
+
+## Allocation
+
+The Allocation resource represents a request to find and allocate a Node
+for deployment. The microversion must be 1.52 or later.
+
+```terraform
+resource "ironic_allocation_v1" "openshift-master-allocation" {
+  name = "master-${count.index}"
+  count = 3
+
+  resource_class = "baremetal"
+
+  candidates = [
+    "${ironic_node_v1.openshift-master-0.id}",
+    "${ironic_node_v1.openshift-master-1.id}",
+    "${ironic_node_v1.openshift-master-2.id}",
+  ]
+
+  traits = [
+    "CUSTOM_FOO",
+  ]
+}
+```
+
 # License
 
 Apache 2.0, See LICENSE file