Merge pull request #1 from segmentio/worker-docs

yields · web-flow · commit 0dfeb007ee05 · 2016-06-15T19:08:40.000+02:00
worker: add usage docs
diff --git a/docs.md b/docs.md
@@ -501,7 +501,18 @@
 
 # worker
 
- Required Variables.
+ The worker module creates an ECS service that has no ELB attached.
+
+ Usage:
+
+     module "my_worker" {
+       source       = "github.com/segmentio/stack"
+       environment  = "prod"
+       name         = "worker"
+       image        = "worker"
+       cluster      = "default"
+     }
+
 
 
 ## Inputs
diff --git a/worker/main.tf b/worker/main.tf
@@ -1,3 +1,19 @@
+/**
+ * The worker module creates an ECS service that has no ELB attached.
+ *
+ * Usage:
+ *
+ *     module "my_worker" {
+ *       source       = "github.com/segmentio/stack"
+ *       environment  = "prod"
+ *       name         = "worker"
+ *       image        = "worker"
+ *       cluster      = "default"
+ *     }
+ *
+ */
+
+
 /**
  * Required Variables.
  */
