Add Python scripts to help migrate daemon and service configs to Spawnpoint 1.0

Author: jhkolb

migration/README.md

@@ -0,0 +1,39 @@
+## Overview
+These Python scripts have been provided to assist users migrating from early
+versions of Spawnpoint (0.x) to the latest version (1.x).
+
+## Updating a Daemon Configuration File
+The script `convertDaemonConfig.py` is used to convert a `spawnd` 0.x
+configuration file into a new `spawnd` configuration that is compatible with
+the 1.x releases of the system. It is used like so:
+```
+$ python convertDaemonConfig.py oldConfig.yml newConfig.yml
+```
+
+Here, `oldConfig.yml` is the name of the current configuration file, while
+`newConfig.yml` is the name of the new 1.x-compatible file that will be created.
+
+Most of the features of the 0.x daemon configuration files have been preserved
+in the 1.x release. The exceptions are:
+  1. The `containerRouter` field has been deprecated. Now, both the daemon and
+     the containers it managers talk to the same Bosswave endpoint, which has
+     been renamed to `bw2Agent` in configuration files for clarity.
+  2. You may no longer specify an `alias` for the `spawnd` instance. Instead,
+     this is assumed to be the last element of the daemon's base URI.
+
+## Updating a Service Configuration File
+This is very similar to updating a daemon configuration. The script
+`convertServiceConfig.py` is used like so:
+```
+$ python convertServiceConfig.py oldDeploy.yml newDeploy.yml
+```
+
+`oldDeploy.yml` is the 0.x-compatible service configuration file, and
+`newDeploy.yml` is the name of the 1.x-compatible file that will be created.
+
+Most of the features of the 0.x service configuration files have been preserved.
+The exceptions are:
+  1. The `overlayNet` field (and Docker overlay networking in general) has been
+     deprecated.
+  2. The `restartInt` field has been deprecated. `spawnd` now reserves the right
+     to handle service restart intervals internally.

migration/convertDaemonConfig.py

@@ -0,0 +1,49 @@
+#! /usr/bin/env python
+import re
+import sys
+
+if len(sys.argv) < 3:
+    print "Usage: {} <daemon config file> <output file>"
+    sys.exit(1)
+daemon_config_file = sys.argv[1]
+output_file = sys.argv[2]
+
+deprecated_fields = ["containerRouter", "alias"]
+
+with open(daemon_config_file) as f:
+    with open(output_file, 'w') as g:
+        for line in f:
+            line = line.strip()
+
+            # Remove deprecated fields
+            if any([line.startswith(x) for x in deprecated_fields]):
+                continue
+
+            # Rename 'entity' to 'bw2Entity'
+            if line.startswith("entity"):
+                line = line.replace("entity", "bw2Entity", 1)
+
+            # Rename 'memAlloc' to 'memory' and convert to MiB
+            elif line.startswith("memAlloc"):
+                match = re.match(r'memAlloc\s*:\s*(\d+)([MmGg])', line)
+                if match is None:
+                    raise ValueError("Invalid memory allocation: {}".format(line))
+                memQuantity = int(match.group(1))
+                memUnits = match.group(2)
+                if memUnits == "G" or memUnits == "g":
+                    memQuantity *= 1024
+                line = "memory: {}".format(memQuantity)
+
+            # Rename "localRouter" to "bw2Agent"
+            elif line.startswith("localRouter"):
+                line = line.replace("localRouter", "bw2Agent")
+
+            # Rename 'allowHostNet' to 'enableHostNetworking'
+            elif line.startswith("allowHostNet"):
+                line = line.replace("allowHostNet", "enableHostNetworking")
+
+            # Rename 'allowDeviceMappings' to 'enableDeviceMapping'
+            elif line.startswith("allowDeviceMappings"):
+                line = line.replace("allowDeviceMappings", "enableDeviceMapping")
+
+            g.write(line + "\n")

migration/convertServiceConfig.py

@@ -0,0 +1,45 @@
+#! /usr/bin/env python
+import re
+import sys
+
+if len(sys.argv) < 3:
+    print "Usage: {} <service config file> <output file>"
+    sys.exit(1)
+daemon_config_file = sys.argv[1]
+output_file = sys.argv[2]
+
+deprecated_fields = ["restartInt", "overlayNet"]
+
+with open(daemon_config_file) as f:
+    with open(output_file, 'w') as g:
+        for line in f:
+            line = line.strip()
+
+            # Remove deprecated fields
+            if any([line.startswith(x) for x in deprecated_fields]):
+                continue
+
+            # Rename 'entity' to 'bw2Entity'
+            if line.startswith("entity"):
+                line = line.replace("entity", "bw2Entity", 1)
+
+            # Rename 'memAlloc' to 'memory' and convert to MiB
+            elif line.startswith("memAlloc"):
+                match = re.match(r'memAlloc\s*:\s*(\d+)([MmGg])', line)
+                if match is None:
+                    raise ValueError("Invalid memory allocation: {}".format(line))
+                memQuantity = int(match.group(1))
+                memUnits = match.group(2)
+                if memUnits == "G" or memUnits == "g":
+                    memQuantity *= 1024
+                line = "memory: {}".format(memQuantity)
+
+            # Rename image 'jhkolb/spawnpoint:amd64' to 'jhkolb/spawnable:amd64'
+            elif line.startswith("image"):
+                line = line.replace("jhkolb/spawnpoint:amd64", "jhkolb/spawnable:amd64")
+
+            # Rename 'includedDirs' to 'includedDirectories'
+            elif line.startswith("includedDirs"):
+                line = line.replace("includedDirs", "includedDirectories", 1)
+
+            g.write(line + "\n")