Support shared attachment in swarm plugin (#476)

Signed-off-by: David Chung <[email protected]>

Author: David Chung

examples/flavor/swarm/flavor.go

@@ -24,11 +24,16 @@ import (
 
 const (
 	ebsAttachment string = "ebs"
+
+	// AllInstances as a special logical ID for use in the Attachments map
+	AllInstances = instance.LogicalID("*")
 )
 
 // Spec is the value passed in the `Properties` field of configs
 type Spec struct {
-	// Attachments indicate the devices that are to be attached to the instance
+
+	// Attachments indicate the devices that are to be attached to the instance.
+	// If the logical ID is '*' (the AllInstances const) then the attachment applies to all instances.
 	Attachments map[instance.LogicalID][]instance.Attachment
 
 	// InitScriptTemplateURL overrides the template specified when the plugin started up.
@@ -316,6 +321,13 @@ func (s *baseFlavor) prepare(role string, flavorProperties *types.Any, instanceS
 		}
 	}
 
+	// look for the AllInstances logicalID in shared attachments
+	for logicalID, attachments := range spec.Attachments {
+		if logicalID == AllInstances {
+			instanceSpec.Attachments = append(instanceSpec.Attachments, attachments...)
+		}
+	}
+
 	// TODO(wfarner): Use the cluster UUID to scope instances for this swarm separately from instances in another
 	// swarm.  This will require plumbing back to Scaled (membership tags).
 	instanceSpec.Tags["swarm-id"] = swarmID
@@ -341,7 +353,7 @@ func validateIDsAndAttachments(logicalIDs []instance.LogicalID,
 		idsMap[id] = true
 	}
 	for id := range attachments {
-		if _, exists := idsMap[id]; !exists {
+		if _, exists := idsMap[id]; !exists && id != AllInstances {
 			return fmt.Errorf("LogicalID %v used for an attachment but is not in group LogicalIDs", id)
 		}
 	}
@@ -350,17 +362,7 @@ func validateIDsAndAttachments(logicalIDs []instance.LogicalID,
 	for _, atts := range attachments {
 		for _, attachment := range atts {
 			if attachment.Type == "" {
-				return fmt.Errorf(
-					"Attachment Type %s must be specified for '%s'",
-					ebsAttachment,
-					attachment.ID)
-			}
-
-			if attachment.Type != ebsAttachment {
-				return fmt.Errorf(
-					"Invalid attachment Type '%s', only %s is supported",
-					attachment.Type,
-					ebsAttachment)
+				return fmt.Errorf("no attachment type")
 			}
 		}
 	}

examples/flavor/swarm/flavor_test.go

@@ -80,14 +80,13 @@ func TestValidate(t *testing.T) {
 	require.Error(t, err)
 	require.Equal(t, "Attachment a specified more than once", err.Error())
 
-	// Unsupported Attachment Type.
+	// Attachment for all
 	err = managerFlavor.Validate(
 		types.AnyString(`{
                         "Docker" : {"Host":"unix:///var/run/docker.sock"},
-			"Attachments": {"127.0.0.1": [{"ID": "a", "Type": "keyboard"}]}}`),
+			"Attachments": {"*": [{"ID": "a", "Type": "NFSVolume"}]}}`),
 		group_types.AllocationMethod{LogicalIDs: []instance.LogicalID{"127.0.0.1"}})
-	require.Error(t, err)
-	require.Equal(t, "Invalid attachment Type 'keyboard', only ebs is supported", err.Error())
+	require.NoError(t, err)
 
 	close(managerStop)
 	close(workerStop)
@@ -192,16 +191,28 @@ func TestManager(t *testing.T) {
 	client.EXPECT().NodeInspectWithRaw(gomock.Any(), nodeID).Return(nodeInfo, nil, nil).AnyTimes()
 	client.EXPECT().Close().AnyTimes()
 
+	flavorSpec := types.AnyString(`
+{
+  "Attachments" : {
+    "10.20.100.1" : [ { "ID" : "disk01", "Type" : "disk" }, { "ID" : "nic01", "Type" : "nic" } ],
+    "10.20.100.2" : [ { "ID" : "disk02", "Type" : "disk" }, { "ID" : "nic02", "Type" : "nic" } ],
+    "10.20.100.3" : [ { "ID" : "disk03", "Type" : "disk" }, { "ID" : "nic03", "Type" : "nic" } ]
+  }
+}
+`)
+
 	index := group_types.Index{Group: group.ID("group"), Sequence: 0}
-	id := instance.LogicalID("127.0.0.1")
-	details, err := flavorImpl.Prepare(
-		types.AnyString(`{"Attachments": {"127.0.0.1": [{"ID": "a", "Type": "gpu"}]}}`),
+	id := instance.LogicalID("10.20.100.1")
+	details, err := flavorImpl.Prepare(flavorSpec,
 		instance.Spec{Tags: map[string]string{"a": "b"}, LogicalID: &id},
-		group_types.AllocationMethod{LogicalIDs: []instance.LogicalID{"127.0.0.1"}},
+		group_types.AllocationMethod{LogicalIDs: []instance.LogicalID{"10.20.100.1"}},
 		index)
 	require.NoError(t, err)
 	require.Equal(t, "b", details.Tags["a"])
 
+	// ensures that the attachments are matched to the logical ID of the instance and in the attachments map
+	require.Equal(t, []instance.Attachment{{ID: "disk01", Type: "disk"}, {ID: "nic01", Type: "nic"}}, details.Attachments)
+
 	link := types.NewLinkFromMap(details.Tags)
 	require.True(t, link.Valid())
 	require.True(t, len(link.KVPairs()) > 0)
@@ -228,6 +239,31 @@ func TestManager(t *testing.T) {
 
 	require.Equal(t, []instance.Attachment{{ID: "a", Type: "gpu"}}, details.Attachments)
 
+	// Shared AllInstances for attachment
+	for _, id := range []instance.LogicalID{
+		instance.LogicalID("10.20.100.1"),
+		instance.LogicalID("10.20.100.2"),
+		instance.LogicalID("10.20.100.3"),
+	} {
+
+		details, err = flavorImpl.Prepare(
+			types.AnyString(`{"Attachments": {"*": [{"ID": "nfs", "Type": "NFSVolume"}]}}`),
+			instance.Spec{Tags: map[string]string{"a": "b"}, LogicalID: &id},
+			group_types.AllocationMethod{LogicalIDs: []instance.LogicalID{"10.20.100.1", "10.20.100.2", "10.20.100.3"}},
+			index)
+		require.NoError(t, err)
+		require.Equal(t, []instance.Attachment{{ID: "nfs", Type: "NFSVolume"}}, details.Attachments)
+	}
+
+	// Shared AllInstances for attachment -- for workers / no special logical IDs
+	details, err = flavorImpl.Prepare(
+		types.AnyString(`{"Attachments": {"*": [{"ID": "nfs", "Type": "NFSVolume"}]}}`),
+		instance.Spec{Tags: map[string]string{"a": "b"}},
+		group_types.AllocationMethod{Size: 10},
+		index)
+	require.NoError(t, err)
+	require.Equal(t, []instance.Attachment{{ID: "nfs", Type: "NFSVolume"}}, details.Attachments)
+
 	// An instance with no association information is considered unhealthy.
 	health, err := flavorImpl.Healthy(types.AnyString("{}"), instance.Description{})
 	require.NoError(t, err)
@@ -278,16 +314,16 @@ func TestTemplateFunctions(t *testing.T) {
 
 	properties := types.AnyString(`
 {
- "Attachments": {"127.0.0.1": [{"ID": "a", "Type": "gpu"}]},
+ "Attachments": {"10.20.100.1": [{"ID": "a", "Type": "gpu"}]},
  "InitScriptTemplateURL" : "str://` + initTemplate + `"
 }
 `)
 
 	index := group_types.Index{Group: group.ID("group"), Sequence: 100}
-	id := instance.LogicalID("127.0.0.1")
+	id := instance.LogicalID("10.20.100.1")
 	details, err := flavorImpl.Prepare(properties,
 		instance.Spec{Tags: map[string]string{"a": "b"}, LogicalID: &id},
-		group_types.AllocationMethod{LogicalIDs: []instance.LogicalID{"127.0.0.1"}},
+		group_types.AllocationMethod{LogicalIDs: []instance.LogicalID{"10.20.100.1"}},
 		index)
 	require.NoError(t, err)
 	require.Equal(t, fmt.Sprintf("%v,%v", index.Group, index.Sequence), details.Init)