Compute v2: Add Live Migration Action

acceptance/clients/clients.go

@@ -6,6 +6,7 @@ package clients
 import (
 	"fmt"
 	"os"
+	"strconv"
 	"strings"
 
 	"github.com/gophercloud/gophercloud"
@@ -42,6 +43,9 @@ type AcceptanceTestChoices struct {
 
 	// DBDatastoreTypeID is the datastore type version for DB tests.
 	DBDatastoreVersion string
+
+	// LiveMigrate indicates ability to run multi-node migration tests
+	LiveMigrate bool
 }
 
 // AcceptanceTestChoicesFromEnv populates a ComputeChoices struct from environment variables.
@@ -56,6 +60,7 @@ func AcceptanceTestChoicesFromEnv() (*AcceptanceTestChoices, error) {
 	shareNetworkID := os.Getenv("OS_SHARE_NETWORK_ID")
 	dbDatastoreType := os.Getenv("OS_DB_DATASTORE_TYPE")
 	dbDatastoreVersion := os.Getenv("OS_DB_DATASTORE_VERSION")
+	liveMigrate := os.Getenv("OS_LIVE_MIGRATE")
 
 	missing := make([]string, 0, 3)
 	if imageID == "" {
@@ -84,6 +89,8 @@ func AcceptanceTestChoicesFromEnv() (*AcceptanceTestChoices, error) {
 		notDistinct = "OS_FLAVOR_ID and OS_FLAVOR_ID_RESIZE must be distinct."
 	}
 
+	LiveMigrate, _ := strconv.ParseBool(liveMigrate)
+
 	if len(missing) > 0 || notDistinct != "" {
 		text := "You're missing some important setup:\n"
 		if len(missing) > 0 {
@@ -106,6 +113,7 @@ func AcceptanceTestChoicesFromEnv() (*AcceptanceTestChoices, error) {
 		ShareNetworkID:     shareNetworkID,
 		DBDatastoreType:    dbDatastoreType,
 		DBDatastoreVersion: dbDatastoreVersion,
+		LiveMigrate:        LiveMigrate,
 	}, nil
 }
 

acceptance/openstack/compute/v2/migrate_test.go

@@ -28,3 +28,40 @@ func TestMigrate(t *testing.T) {
 		t.Fatalf("Error during migration: %v", err)
 	}
 }
+
+func TestLiveMigrate(t *testing.T) {
+	choices, err := clients.AcceptanceTestChoicesFromEnv()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	if !choices.LiveMigrate {
+		t.Skip()
+	}
+
+	client, err := clients.NewComputeV2Client()
+	if err != nil {
+		t.Fatalf("Unable to create a compute client: %v", err)
+	}
+
+	server, err := CreateServer(t, client)
+	if err != nil {
+		t.Fatalf("Unable to create server: %v", err)
+	}
+	defer DeleteServer(t, client, server)
+
+	t.Logf("Attempting to migrate server %s", server.ID)
+
+	blockMigration := false
+	diskOverCommit := false
+
+	liveMigrateOpts := migrate.LiveMigrateOpts{
+		BlockMigration: &blockMigration,
+		DiskOverCommit: &diskOverCommit,
+	}
+
+	err = migrate.LiveMigrate(client, server.ID, liveMigrateOpts).ExtractErr()
+	if err != nil {
+		t.Fatalf("Error during live migration: %v", err)
+	}
+}

openstack/compute/v2/extensions/migrate/doc.go

@@ -2,12 +2,29 @@
 Package migrate provides functionality to migrate servers that have been
 provisioned by the OpenStack Compute service.
 
-Example to Migrate a Server
+Example of Migrate Server (migrate Action)
 
 	serverID := "b16ba811-199d-4ffd-8839-ba96c1185a67"
 	err := migrate.Migrate(computeClient, serverID).ExtractErr()
 	if err != nil {
 		panic(err)
 	}
+
+Example of Live-Migrate Server (os-migrateLive Action)
+
+	serverID := "b16ba811-199d-4ffd-8839-ba96c1185a67"
+	host := "01c0cadef72d47e28a672a76060d492c"
+	blockMigration := false
+
+	migrationOpts := migrate.LiveMigrateOpts{
+		Host: &host,
+		BlockMigration: &blockMigration,
+	}
+
+	err := migrate.LiveMigrate(computeClient, serverID, migrationOpts).ExtractErr()
+	if err != nil {
+		panic(err)
+	}
+
 */
 package migrate

openstack/compute/v2/extensions/migrate/requests.go

@@ -9,3 +9,42 @@ func Migrate(client *gophercloud.ServiceClient, id string) (r MigrateResult) {
 	_, r.Err = client.Post(actionURL(client, id), map[string]interface{}{"migrate": nil}, nil, nil)
 	return
 }
+
+// LiveMigrateOptsBuilder allows extensions to add additional parameters to the
+// LiveMigrate request.
+type LiveMigrateOptsBuilder interface {
+	ToLiveMigrateMap() (map[string]interface{}, error)
+}
+
+// LiveMigrateOpts specifies parameters of live migrate action.
+type LiveMigrateOpts struct {
+	// The host to which to migrate the server.
+	// If this parameter is None, the scheduler chooses a host.
+	Host *string `json:"host"`
+
+	// Set to True to migrate local disks by using block migration.
+	// If the source or destination host uses shared storage and you set
+	// this value to True, the live migration fails.
+	BlockMigration *bool `json:"block_migration,omitempty"`
+
+	// Set to True to enable over commit when the destination host is checked
+	// for available disk space. Set to False to disable over commit. This setting
+	// affects only the libvirt virt driver.
+	DiskOverCommit *bool `json:"disk_over_commit,omitempty"`
+}
+
+// ToLiveMigrateMap constructs a request body from LiveMigrateOpts.
+func (opts LiveMigrateOpts) ToLiveMigrateMap() (map[string]interface{}, error) {
+	return gophercloud.BuildRequestBody(opts, "os-migrateLive")
+}
+
+// LiveMigrate will initiate a live-migration (without rebooting) of the instance to another host.
+func LiveMigrate(client *gophercloud.ServiceClient, id string, opts LiveMigrateOptsBuilder) (r MigrateResult) {
+	b, err := opts.ToLiveMigrateMap()
+	if err != nil {
+		r.Err = err
+		return
+	}
+	_, r.Err = client.Post(actionURL(client, id), b, nil, nil)
+	return
+}

openstack/compute/v2/extensions/migrate/testing/fixtures.go

@@ -16,3 +16,18 @@ func mockMigrateResponse(t *testing.T, id string) {
 		w.WriteHeader(http.StatusAccepted)
 	})
 }
+
+func mockLiveMigrateResponse(t *testing.T, id string) {
+	th.Mux.HandleFunc("/servers/"+id+"/action", func(w http.ResponseWriter, r *http.Request) {
+		th.TestMethod(t, r, "POST")
+		th.TestHeader(t, r, "X-Auth-Token", client.TokenID)
+		th.TestJSONRequest(t, r, `{
+			"os-migrateLive": {
+				"host": "01c0cadef72d47e28a672a76060d492c",
+				"block_migration": false,
+				"disk_over_commit": true
+			}
+		}`)
+		w.WriteHeader(http.StatusAccepted)
+	})
+}

openstack/compute/v2/extensions/migrate/testing/requests_test.go

@@ -19,3 +19,23 @@ func TestMigrate(t *testing.T) {
 	err := migrate.Migrate(client.ServiceClient(), serverID).ExtractErr()
 	th.AssertNoErr(t, err)
 }
+
+func TestLiveMigrate(t *testing.T) {
+	th.SetupHTTP()
+	defer th.TeardownHTTP()
+
+	mockLiveMigrateResponse(t, serverID)
+
+	host := "01c0cadef72d47e28a672a76060d492c"
+	blockMigration := false
+	diskOverCommit := true
+
+	migrationOpts := migrate.LiveMigrateOpts{
+		Host:           &host,
+		BlockMigration: &blockMigration,
+		DiskOverCommit: &diskOverCommit,
+	}
+
+	err := migrate.LiveMigrate(client.ServiceClient(), serverID, migrationOpts).ExtractErr()
+	th.AssertNoErr(t, err)
+}