alexlebens/external-snapshotter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update exported function details with source code comments.

Browse Source 
Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
This commit is contained in:
Humble Chirammal
2019-01-06 14:48:53 +05:30
parent 9708a1b090
commit 164d10a824
5 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/apis/volumesnapshot/v1alpha1/types.go
View File

@@ -214,7 +214,7 @@ type VolumeSnapshotSource struct {
CSI *CSIVolumeSnapshotSource `json:"csiVolumeSnapshotSource,omitempty"` CSI *CSIVolumeSnapshotSource `json:"csiVolumeSnapshotSource,omitempty"`
} }
// Represents the source from CSI volume snapshot // CSIVolumeSnapshotSource represents the source from CSI volume snapshot
type CSIVolumeSnapshotSource struct { type CSIVolumeSnapshotSource struct {
// Driver is the name of the driver to use for this snapshot. // Driver is the name of the driver to use for this snapshot.
// This MUST be the same name returned by the CSI GetPluginName() call for // This MUST be the same name returned by the CSI GetPluginName() call for

1
pkg/connection/connection.go
View File

@@ -72,6 +72,7 @@ var (
_ CSIConnection = &csiConnection{} _ CSIConnection = &csiConnection{}
) )
// New returns a CSI connection object.
func New(address string, timeout time.Duration) (CSIConnection, error) { func New(address string, timeout time.Duration) (CSIConnection, error) {
conn, err := connect(address, timeout) conn, err := connect(address, timeout)
if err != nil { if err != nil {

1
pkg/controller/csi_handler.go
View File

@@ -42,6 +42,7 @@ type csiHandler struct {
snapshotNameUUIDLength int snapshotNameUUIDLength int
} }
// NewCSIHandler returns a handler which includes the csi connection and Snapshot name details
func NewCSIHandler( func NewCSIHandler(
csiConnection connection.CSIConnection, csiConnection connection.CSIConnection,
timeout time.Duration, timeout time.Duration,

1
pkg/controller/snapshot_controller.go
View File

@@ -440,6 +440,7 @@ func getSnapshotStatusForLogging(snapshot *crdv1.VolumeSnapshot) string {
return fmt.Sprintf("bound to: %q, Completed: %v", snapshot.Spec.SnapshotContentName, snapshot.Status.ReadyToUse) return fmt.Sprintf("bound to: %q, Completed: %v", snapshot.Spec.SnapshotContentName, snapshot.Status.ReadyToUse)
} }
// IsSnapshotBound returns true/false if snapshot is bound
func IsSnapshotBound(snapshot *crdv1.VolumeSnapshot, content *crdv1.VolumeSnapshotContent) bool { func IsSnapshotBound(snapshot *crdv1.VolumeSnapshot, content *crdv1.VolumeSnapshotContent) bool {
if content.Spec.VolumeSnapshotRef != nil && content.Spec.VolumeSnapshotRef.Name == snapshot.Name && if content.Spec.VolumeSnapshotRef != nil && content.Spec.VolumeSnapshotRef.Name == snapshot.Name &&
content.Spec.VolumeSnapshotRef.UID == snapshot.UID { content.Spec.VolumeSnapshotRef.UID == snapshot.UID {

2
pkg/controller/util.go
View File

@@ -320,7 +320,7 @@ func getCredentials(k8s kubernetes.Interface, ref *v1.SecretReference) (map[stri
return credentials, nil return credentials, nil
} }
// Returns 0 for resyncPeriod in case resyncing is not needed. // NoResyncPeriodFunc Returns 0 for resyncPeriod in case resyncing is not needed.
func NoResyncPeriodFunc() time.Duration { func NoResyncPeriodFunc() time.Duration {
return 0 return 0
} }