snapshot_service.go

/*
Copyright 2017 Heptio Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package cloudprovider

import (
	"fmt"
	"time"
)

// SnapshotService exposes Ark-specific operations for snapshotting and restoring block
// volumes.
type SnapshotService interface {
	// GetAllSnapshots returns a slice of all snapshots found in the cloud API that
	// are tagged with Ark metadata. Returns an error if a problem is encountered accessing
	// the cloud API.
	GetAllSnapshots() ([]string, error)

	// CreateSnapshot triggers a snapshot for the specified cloud volume and tags it with metadata.
	// it returns the cloud snapshot ID, or an error if a problem is encountered triggering the snapshot via
	// the cloud API.
	CreateSnapshot(volumeID string) (string, error)

	// CreateVolumeFromSnapshot triggers a restore operation to create a new cloud volume from the specified
	// snapshot and volume characteristics. Returns the cloud volume ID, or an error if a problem is
	// encountered triggering the restore via the cloud API.
	CreateVolumeFromSnapshot(snapshotID, volumeType string, iops *int64) (string, error)

	// DeleteSnapshot triggers a deletion of the specified Ark snapshot via the cloud API. It returns an
	// error if a problem is encountered triggering the deletion via the cloud API.
	DeleteSnapshot(snapshotID string) error

	// GetVolumeInfo gets the type and IOPS (if applicable) from the cloud API.
	GetVolumeInfo(volumeID string) (string, *int64, error)
}

const (
	volumeCreateWaitTimeout  = 30 * time.Second
	volumeCreatePollInterval = 1 * time.Second
	snapshotTagKey           = "tag-key"
	snapshotTagVal           = "ark-snapshot"
)

type snapshotService struct {
	blockStorage BlockStorageAdapter
}

var _ SnapshotService = &snapshotService{}

// NewSnapshotService creates a snapshot service using the provided block storage adapter
func NewSnapshotService(blockStorage BlockStorageAdapter) SnapshotService {
	return &snapshotService{
		blockStorage: blockStorage,
	}
}

func (sr *snapshotService) CreateVolumeFromSnapshot(snapshotID string, volumeType string, iops *int64) (string, error) {
	volumeID, err := sr.blockStorage.CreateVolumeFromSnapshot(snapshotID, volumeType, iops)
	if err != nil {
		return "", err
	}

	// wait for volume to be ready (up to a maximum time limit)
	ticker := time.NewTicker(volumeCreatePollInterval)
	defer ticker.Stop()

	timeout := time.NewTimer(volumeCreateWaitTimeout)

	for {
		select {
		case <-timeout.C:
			return "", fmt.Errorf("timeout reached waiting for volume %v to be ready", volumeID)
		case <-ticker.C:
			if ready, err := sr.blockStorage.IsVolumeReady(volumeID); err == nil && ready {
				return volumeID, nil
			}
		}
	}
}

func (sr *snapshotService) GetAllSnapshots() ([]string, error) {
	tags := map[string]string{
		snapshotTagKey: snapshotTagVal,
	}

	res, err := sr.blockStorage.ListSnapshots(tags)
	if err != nil {
		return nil, err
	}

	return res, nil
}

func (sr *snapshotService) CreateSnapshot(volumeID string) (string, error) {
	tags := map[string]string{
		snapshotTagKey: snapshotTagVal,
	}

	return sr.blockStorage.CreateSnapshot(volumeID, tags)
}

func (sr *snapshotService) DeleteSnapshot(snapshotID string) error {
	return sr.blockStorage.DeleteSnapshot(snapshotID)
}

func (sr *snapshotService) GetVolumeInfo(volumeID string) (string, *int64, error) {
	return sr.blockStorage.GetVolumeInfo(volumeID)
}