Add some descriptions to the terraform pieces.

rackn · Oct 10, 2017 · ea5833e · ea5833e
1 parent bbbc9b0
commit ea5833e
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 2 deletions.
diff --git a/terraform/params/terraform.allocated.json b/terraform/params/terraform.allocated.json
@@ -1,5 +1,6 @@
 {
   "Name": "terraform/allocated",
+  "Description": "Indicates if this machine has been allocated by terraform",
   "Schema": {
     "type": "boolean"
   },

diff --git a/terraform/params/terraform.managed.json b/terraform/params/terraform.managed.json
@@ -1,5 +1,6 @@
 {
   "Name": "terraform/managed",
+  "Description": "Indicates if this machine can be managed by terraform",
   "Schema": {
     "type": "boolean"
   },

diff --git a/terraform/params/terraform.owner.json b/terraform/params/terraform.owner.json
@@ -1,5 +1,6 @@
 {
   "Name": "terraform/owner",
+  "Description": "Helper parameter that indicates who allocated this machine",
   "Schema": {
     "type": "string"
   },

diff --git a/terraform/params/terraform.poweroff.json b/terraform/params/terraform.poweroff.json
@@ -1,5 +1,6 @@
 {
   "Name": "terraform/poweroff",
+  "Description": "Indicates whether the machine should be powered off while awaiting allocation by terraform",
   "Schema": {
     "type": "boolean"
   },

diff --git a/terraform/profiles/terraform-managed.json b/terraform/profiles/terraform-managed.json
@@ -1,5 +1,6 @@
 {
   "Name": "terraform-managed",
+  "Description": "Example base state for machines wanting to be managed by terraform",
   "Params": {
     "terraform/managed": true,
     "terraform/allocated": false

diff --git a/terraform/stages/terraform-ready.yaml b/terraform/stages/terraform-ready.yaml
@@ -1,9 +1,10 @@
 ---
 Name: "terraform-ready"
 BootEnv: "sledgehammer"
+Description: "marks a machine as managed by terraform and ready for allocation"
 Tasks:
   - "terraform-enable"
 Meta:
   icon: "map outline"
-  color: green
-  title: "RackN Content"
+  color: "green"
+  title: "RackN Content"