Add method comments

Signed-off-by: Madhu Rajanna <mrajanna@redhat.com>

pkg/cephfs/controllerserver.go

@@ -28,6 +28,8 @@ import (
 	"github.com/ceph/ceph-csi/pkg/util"
 )
 
+// ControllerServer struct of CEPH CSI driver with supported methods of CSI
+// controller server spec.
 type ControllerServer struct {
 	*csicommon.DefaultControllerServer
 	MetadataStore util.CachePersister
@@ -38,6 +40,7 @@ type controllerCacheEntry struct {
 	VolumeID   volumeID
 }
 
+// CreateVolume creates the volume in backend and store the volume metadata
 func (cs *ControllerServer) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest) (*csi.CreateVolumeResponse, error) {
 	if err := cs.validateCreateVolumeRequest(req); err != nil {
 		glog.Errorf("CreateVolumeRequest validation failed: %v", err)
@@ -102,6 +105,8 @@ func (cs *ControllerServer) CreateVolume(ctx context.Context, req *csi.CreateVol
 	}, nil
 }
 
+// DeleteVolume deletes the volume in backend and removes the volume metadata
+// from store
 func (cs *ControllerServer) DeleteVolume(ctx context.Context, req *csi.DeleteVolumeRequest) (*csi.DeleteVolumeResponse, error) {
 	if err := cs.validateDeleteVolumeRequest(); err != nil {
 		glog.Errorf("DeleteVolumeRequest validation failed: %v", err)
@@ -159,6 +164,8 @@ func (cs *ControllerServer) DeleteVolume(ctx context.Context, req *csi.DeleteVol
 	return &csi.DeleteVolumeResponse{}, nil
 }
 
+// ValidateVolumeCapabilities checks whether the volume capabilities requested
+// are supported.
 func (cs *ControllerServer) ValidateVolumeCapabilities(
 	ctx context.Context,
 	req *csi.ValidateVolumeCapabilitiesRequest) (*csi.ValidateVolumeCapabilitiesResponse, error) {

pkg/cephfs/driver.go

@@ -26,10 +26,13 @@ import (
 )
 
 const (
+	// PluginFolder defines the location of ceph plugin
 	PluginFolder = "/var/lib/kubelet/plugins/csi-cephfsplugin"
-	Version      = "1.0.0"
+	// version of ceph driver
+	version = "1.0.0"
 )
 
+// Driver contains the default identity,node and controller struct
 type Driver struct {
 	cd *csicommon.CSIDriver
 
@@ -39,19 +42,23 @@ type Driver struct {
 }
 
 var (
+	// DefaultVolumeMounter for mounting volumes
 	DefaultVolumeMounter string
 )
 
+// NewDriver returns new ceph driver
 func NewDriver() *Driver {
 	return &Driver{}
 }
 
+// NewIdentityServer initialize a identity server for ceph CSI driver
 func NewIdentityServer(d *csicommon.CSIDriver) *IdentityServer {
 	return &IdentityServer{
 		DefaultIdentityServer: csicommon.NewDefaultIdentityServer(d),
 	}
 }
 
+// NewControllerServer initialize a controller server for ceph CSI driver
 func NewControllerServer(d *csicommon.CSIDriver, cachePersister util.CachePersister) *ControllerServer {
 	return &ControllerServer{
 		DefaultControllerServer: csicommon.NewDefaultControllerServer(d),
@@ -59,14 +66,17 @@ func NewControllerServer(d *csicommon.CSIDriver, cachePersister util.CachePersis
 	}
 }
 
+// NewNodeServer initialize a node server for ceph CSI driver.
 func NewNodeServer(d *csicommon.CSIDriver) *NodeServer {
 	return &NodeServer{
 		DefaultNodeServer: csicommon.NewDefaultNodeServer(d),
 	}
 }
 
+// Run start a non-blocking grpc controller,node and identityserver for
+// ceph CSI driver which can serve multiple parallel requests
 func (fs *Driver) Run(driverName, nodeID, endpoint, volumeMounter string, cachePersister util.CachePersister) {
-	glog.Infof("Driver: %v version: %v", driverName, Version)
+	glog.Infof("Driver: %v version: %v", driverName, version)
 
 	// Configuration
 
@@ -91,7 +101,7 @@ func (fs *Driver) Run(driverName, nodeID, endpoint, volumeMounter string, cacheP
 
 	// Initialize default library driver
 
-	fs.cd = csicommon.NewCSIDriver(driverName, Version, nodeID)
+	fs.cd = csicommon.NewCSIDriver(driverName, version, nodeID)
 	if fs.cd == nil {
 		glog.Fatalln("Failed to initialize CSI driver")
 	}

pkg/cephfs/identityserver.go

@@ -23,10 +23,13 @@ import (
 	"github.com/kubernetes-csi/drivers/pkg/csi-common"
 )
 
+// IdentityServer struct of ceph CSI driver with supported methods of CSI
+// identity server spec.
 type IdentityServer struct {
 	*csicommon.DefaultIdentityServer
 }
 
+// GetPluginCapabilities returns available capabilities of the ceph driver
 func (is *IdentityServer) GetPluginCapabilities(ctx context.Context, req *csi.GetPluginCapabilitiesRequest) (*csi.GetPluginCapabilitiesResponse, error) {
 	return &csi.GetPluginCapabilitiesResponse{
 		Capabilities: []*csi.PluginCapability{

pkg/cephfs/nodeserver.go

@@ -29,6 +29,8 @@ import (
 	"github.com/kubernetes-csi/drivers/pkg/csi-common"
 )
 
+// NodeServer struct of ceph CSI driver with supported methods of CSI
+// node server spec.
 type NodeServer struct {
 	*csicommon.DefaultNodeServer
 }
@@ -77,6 +79,7 @@ func getCredentialsForVolume(volOptions *volumeOptions, volID volumeID, req *csi
 	return userCr, nil
 }
 
+// NodeStageVolume mounts the volume to a staging path on the node.
 func (ns *NodeServer) NodeStageVolume(ctx context.Context, req *csi.NodeStageVolumeRequest) (*csi.NodeStageVolumeResponse, error) {
 	if err := validateNodeStageVolumeRequest(req); err != nil {
 		return nil, status.Error(codes.InvalidArgument, err.Error())
@@ -149,6 +152,8 @@ func (ns *NodeServer) NodeStageVolume(ctx context.Context, req *csi.NodeStageVol
 	return &csi.NodeStageVolumeResponse{}, nil
 }
 
+// NodePublishVolume mounts the volume mounted to the staging path to the target
+// path
 func (ns *NodeServer) NodePublishVolume(ctx context.Context, req *csi.NodePublishVolumeRequest) (*csi.NodePublishVolumeResponse, error) {
 	if err := validateNodePublishVolumeRequest(req); err != nil {
 		return nil, status.Error(codes.InvalidArgument, err.Error())
@@ -190,6 +195,7 @@ func (ns *NodeServer) NodePublishVolume(ctx context.Context, req *csi.NodePublis
 	return &csi.NodePublishVolumeResponse{}, nil
 }
 
+// NodeUnpublishVolume unmounts the volume from the target path
 func (ns *NodeServer) NodeUnpublishVolume(ctx context.Context, req *csi.NodeUnpublishVolumeRequest) (*csi.NodeUnpublishVolumeResponse, error) {
 	if err := validateNodeUnpublishVolumeRequest(req); err != nil {
 		return nil, status.Error(codes.InvalidArgument, err.Error())
@@ -209,6 +215,7 @@ func (ns *NodeServer) NodeUnpublishVolume(ctx context.Context, req *csi.NodeUnpu
 	return &csi.NodeUnpublishVolumeResponse{}, nil
 }
 
+// NodeUnstageVolume unstages the volume from the staging path
 func (ns *NodeServer) NodeUnstageVolume(ctx context.Context, req *csi.NodeUnstageVolumeRequest) (*csi.NodeUnstageVolumeResponse, error) {
 	if err := validateNodeUnstageVolumeRequest(req); err != nil {
 		return nil, status.Error(codes.InvalidArgument, err.Error())
@@ -228,6 +235,7 @@ func (ns *NodeServer) NodeUnstageVolume(ctx context.Context, req *csi.NodeUnstag
 	return &csi.NodeUnstageVolumeResponse{}, nil
 }
 
+// NodeGetCapabilities returns the supported capabilities of the node server
 func (ns *NodeServer) NodeGetCapabilities(ctx context.Context, req *csi.NodeGetCapabilitiesRequest) (*csi.NodeGetCapabilitiesResponse, error) {
 	return &csi.NodeGetCapabilitiesResponse{
 		Capabilities: []*csi.NodeServiceCapability{
@@ -241,7 +249,3 @@ func (ns *NodeServer) NodeGetCapabilities(ctx context.Context, req *csi.NodeGetC
 		},
 	}, nil
 }
-
-func (ns *NodeServer) NodeGetInfo(ctx context.Context, req *csi.NodeGetInfoRequest) (*csi.NodeGetInfoResponse, error) {
-	return ns.DefaultNodeServer.NodeGetInfo(ctx, req)
-}