From b7f3e24391995e15b451d1ccbdaa5d3318e6bfa3 Mon Sep 17 00:00:00 2001
From: Alex Dadgar <alex.dadgar@gmail.com>
Date: Tue, 28 Aug 2018 15:00:48 -0700
Subject: [PATCH] launcher readme

---
 plugins/device/cmd/example/device.go  |  2 +-
 plugins/shared/cmd/launcher/README.md | 64 ++++++++++++++++++++++++++-
 2 files changed, 63 insertions(+), 3 deletions(-)

diff --git a/plugins/device/cmd/example/device.go b/plugins/device/cmd/example/device.go
index 8287d6373..6d6292043 100644
--- a/plugins/device/cmd/example/device.go
+++ b/plugins/device/cmd/example/device.go
@@ -57,7 +57,7 @@ var (
 			hclspec.NewLiteral("\"-rwxrwxrwx\""),
 		),
 		"stats_period": hclspec.NewDefault(
-			hclspec.NewAttr("list_period", "string", false),
+			hclspec.NewAttr("stats_period", "string", false),
 			hclspec.NewLiteral("\"5s\""),
 		),
 	})
diff --git a/plugins/shared/cmd/launcher/README.md b/plugins/shared/cmd/launcher/README.md
index ff3e18ee2..06c6c65e1 100644
--- a/plugins/shared/cmd/launcher/README.md
+++ b/plugins/shared/cmd/launcher/README.md
@@ -1,3 +1,63 @@
 This command allows plugin developers to interact with a plugin directly. The
-command has subcommands for each plugin type. See the subcommands for usage
-information.
+command has subcommands for each plugin type. See the subcommand help text for
+detailed usage information.
+
+# Device Example
+
+The `device` subcommand provides a way to interact and visualize the data being
+returned by a device plugin. As an example we will run the example device
+plugin. To use this command with your own device plugin substitute the example
+plugin with your own.
+
+
+```
+# Current working directory should be the root folder: github.com/hashicorp/nomad
+
+# Build the plugin launcher
+$ go build github.com/hashicorp/nomad/plugins/shared/cmd/launcher/
+
+# Build the example fs-device plugin
+$ go build -o fs-device github.com/hashicorp/nomad/plugins/device/cmd/example/cmd
+
+# Launch the plugin
+$ ./launcher device ./fs-device
+> Availabile commands are: exit(), fingerprint(), stop_fingerprint(), stats(), stop_stats(), reserve(id1, id2, ...)
+>  2018-08-28T14:54:45.658-0700 [INFO ] nomad-plugin-launcher.fs-device: config set: @module=example-fs-device config="example.Config{Dir:".", ListPeriod:"5s", StatsPeriod:"5s", UnhealthyPerm:"-rwxrwxrwx"}" timestamp=2018-08-28T14:54:45.658-0700
+
+^C
+2018-08-28T14:54:54.727-0700 [ERROR] nomad-plugin-launcher: error interacting with plugin: error=interrupted
+
+# Lets launch changing the configuration
+$ cat <<\EOF >fs-device.config
+> config {
+>   dir = "./plugins"
+>   stats_period = "2s"
+> }
+> EOF
+
+$ ./launcher device ./fs-device ./fs-device.config
+2018-08-28T14:59:45.886-0700 [INFO ] nomad-plugin-launcher.fs-device: config set: @module=example-fs-device config="example.Config{Dir:"./plugins", ListPeriod:"5s", StatsPeriod:"2s", UnhealthyPerm:"-rwxrwxrwx"}" timestamp=2018-08-28T14:59:45.886-0700
+> Availabile commands are: exit(), fingerprint(), stop_fingerprint(), stats(), stop_stats(), reserve(id1, id2, ...)
+>  fingerprint()
+>  > fingerprint: &device.FingerprintResponse{
+    Devices: {
+        &device.DeviceGroup{
+            Vendor:  "nomad",
+            Type:    "file",
+            Name:    "mock",
+            Devices: {
+                &device.Device{
+                    ID:         "serve.go",
+                    Healthy:    true,
+                    HealthDesc: "",
+                    HwLocality: (*device.DeviceLocality)(nil),
+                },
+            },
+            Attributes: {},
+        },
+    },
+    Error: nil,
+}
+^C
+2018-08-28T15:00:00.329-0700 [ERROR] nomad-plugin-launcher: error interacting with plugin: error=interrupted
+```