Edit volume api

e2e/volume_ops_test.go

@@ -65,6 +65,9 @@ func TestVolume(t *testing.T) {
 
 	// Disperse volume test
 	t.Run("Disperse", testDisperse)
+
+	// Edit Volume Metadata test
+	t.Run("Edit", testEditVolume)
 }
 
 func testVolumeCreate(t *testing.T) {
@@ -409,3 +412,41 @@ func testDisperse(t *testing.T) {
 	r.Nil(client.VolumeStop(disperseVolName), "disperse volume stop failed")
 	r.Nil(client.VolumeDelete(disperseVolName), "disperse volume delete failed")
 }
+
+func testEditVolume(t *testing.T) {
+	r := require.New(t)
+
+	var brickPaths []string
+
+	for i := 1; i <= 4; i++ {
+		brickPath, err := ioutil.TempDir(tmpDir, "brick")
+		r.Nil(err)
+		brickPaths = append(brickPaths, brickPath)
+	}
+
+	createReq := api.VolCreateReq{
+		Name: volname,
+		Subvols: []api.SubvolReq{
+			{
+				ReplicaCount: 2,
+				Type:         "replicate",
+				Bricks: []api.BrickReq{
+					{PeerID: gds[0].PeerID(), Path: brickPaths[0]},
+					{PeerID: gds[1].PeerID(), Path: brickPaths[1]},
+				},
+			},
+		},
+		Force: true,
+	}
+	_, err := client.VolumeCreate(createReq)
+
+	editMetadataReq := api.VolEditReq{
+		Metadata: map[string]string{
+			"owner": "gd2tests",
+		},
+	}
+	_, err = client.EditVolume(volname, editMetadataReq)
+	r.Nil(err)
+	err = client.VolumeDelete(volname)
+	r.Nil(err)
+}

glusterd2/commands/volumes/commands.go

@@ -127,6 +127,13 @@ func (c *Command) Routes() route.Routes {
 			Pattern:     "/volfiles",
 			Version:     1,
 			HandlerFunc: volfilesListHandler},
+		route.Route{
+			Name:        "EditVolume",
+			Method:      "POST",
+			Pattern:     "/volumes/{volname}/edit",
+			Version:     1,
+			RequestType: utils.GetTypeString((*api.VolumeGetResp)(nil)),
+			HandlerFunc: volumeEditHandler},
 	}
 }
 

glusterd2/commands/volumes/volume-edit.go

@@ -0,0 +1,94 @@
+package volumecommands
+
+import (
+	"net/http"
+	"strings"
+
+	"github.com/gluster/glusterd2/glusterd2/gdctx"
+	restutils "github.com/gluster/glusterd2/glusterd2/servers/rest/utils"
+	"github.com/gluster/glusterd2/glusterd2/transaction"
+	"github.com/gluster/glusterd2/glusterd2/volume"
+	"github.com/gluster/glusterd2/pkg/api"
+	"github.com/gluster/glusterd2/pkg/errors"
+
+	"github.com/gorilla/mux"
+	"github.com/pborman/uuid"
+)
+
+func volumeEditHandler(w http.ResponseWriter, r *http.Request) {
+
+	p := mux.Vars(r)
+	volname := p["volname"]
+
+	ctx := r.Context()
+	logger := gdctx.GetReqLogger(ctx)
+
+	var req api.VolEditReq
+	if err := restutils.UnmarshalRequest(r, &req); err != nil {
+		restutils.SendHTTPError(ctx, w, http.StatusBadRequest, err)
+		return
+	}
+
+	//Lock on Volume Name
+	lock, unlock := transaction.CreateLockFuncs(volname)
+	// Taking a lock outside the txn as volinfo.Nodes() must also
+	// be populated holding the lock.
+	if err := lock(ctx); err != nil {
+		if err == transaction.ErrLockTimeout {
+			restutils.SendHTTPError(ctx, w, http.StatusConflict, err)
+		} else {
+			restutils.SendHTTPError(ctx, w, http.StatusInternalServerError, err)
+		}
+		return
+	}
+	defer unlock(ctx)
+
+	//validate volume name
+	v, err := volume.GetVolume(volname)
+	if err != nil {
+		if err == errors.ErrVolNotFound {
+			restutils.SendHTTPError(ctx, w, http.StatusNotFound, errors.ErrVolNotFound)
+		} else {
+			restutils.SendHTTPError(ctx, w, http.StatusInternalServerError, err)
+		}
+		return
+	}
+
+	for key := range req.Metadata {
+		if strings.HasPrefix(key, "_") {
+			logger.WithField("key", key).Error("Key names starting with '_' are restricted in metadata field")
+			restutils.SendHTTPError(ctx, w, http.StatusBadRequest, "Key names starting with '_' are restricted in metadata field")
+			return
+		}
+	}
+
+	v.Metadata = req.Metadata
+
+	// Transaction which starts self heal daemon on all nodes with atleast one brick.
+	txn := transaction.NewTxn(ctx)
+	defer txn.Cleanup()
+
+	txn.Nodes = v.Nodes()
+	txn.Steps = []*transaction.Step{
+		{
+			DoFunc: "vol-option.UpdateVolinfo",
+			Nodes:  []uuid.UUID{gdctx.MyUUID},
+		},
+	}
+
+	if err := txn.Ctx.Set("volinfo", v); err != nil {
+		logger.WithError(err).WithField("key", "volinfo").Error("failed to set key in transaction context")
+		restutils.SendHTTPError(ctx, w, http.StatusInternalServerError, err)
+		return
+	}
+
+	err = txn.Do()
+	if err != nil {
+		logger.WithField("volname", volname).Error("failed to edit metadata")
+		restutils.SendHTTPError(ctx, w, http.StatusInternalServerError, err)
+		return
+	}
+
+	resp := createVolumeGetResp(v)
+	restutils.SendHTTPResponse(ctx, w, http.StatusOK, resp)
+}

pkg/api/volume_req.go

@@ -82,3 +82,8 @@ type VolStatedumpReq struct {
 	Quota  bool            `json:"quotad,omitempty"`
 	Client ClientStatedump `json:"client,omitempty"`
 }
+
+// VolEditReq represents a volume metadata edit request
+type VolEditReq struct {
+	Metadata map[string]string `json:"metadata"`
+}

pkg/restclient/volume.go

@@ -107,3 +107,11 @@ func (c *Client) OptionGroupDelete(group string) error {
 	url := fmt.Sprintf("/v1/volumes/options-group/%s", group)
 	return c.del(url, nil, http.StatusOK, nil)
 }
+
+// EditVolume edits the specified keys in volinfo of a volume
+func (c *Client) EditVolume(volname string, req api.VolEditReq) (api.VolumeGetResp, error) {
+	var resp api.VolumeGetResp
+	url := fmt.Sprintf("/v1/volumes/%s/edit", volname)
+	err := c.post(url, req, http.StatusOK, &resp)
+	return resp, err
+}