https://github.com/rootfs/snapshot

Kubernetes Volume Snapshot Controller using Custom Resource Definition
https://github.com/rootfs/snapshot

kubernetes

Last synced: 12 days ago
JSON representation

Kubernetes Volume Snapshot Controller using Custom Resource Definition

• Host: GitHub
• URL: https://github.com/rootfs/snapshot
• Owner: rootfs
• License: apache-2.0
• Created: 2017-05-25T18:15:06.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-09-20T17:29:42.000Z (about 7 years ago)
• Last Synced: 2024-06-21T16:44:21.484Z (5 months ago)
• Topics: kubernetes
• Language: Go
• Homepage:
• Size: 33.4 MB
• Stars: 12
• Watchers: 5
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Volume Snapshot Controller

## Status

No longer maintained. Please use https://github.com/kubernetes-incubator/external-storage/

## Demo

 - [SIG PM 06/13/2017](https://youtu.be/7-mBY_ZitS8?t=24m41s)

## Quick Howto

 - [Host Path](examples/hostpath/README.md)

 - [AWS EBS](examples/aws/README.md)

## Snapshot Volume Plugin Interface

As illustrated in example plugin [hostPath](pkg/volume/hostpath/processor.go)

### Plugin API

A Volume plugin must provide `RegisterPlugin()` to return plugin struct, `GetPluginName()` to return plugin name, and implement the following interface as illustrated in [hostPath](pkg/volume/hostpath/processor.go)

```go

import (

	"k8s.io/client-go/pkg/api/v1"

	crdv1 "github.com/rootfs/snapshot/pkg/apis/crd/v1"

	"github.com/rootfs/snapshot/pkg/cloudprovider"

)

type VolumePlugin interface {

	// Init inits volume plugin

	Init(cloudprovider.Interface)

	// SnapshotCreate creates a VolumeSnapshot from a PersistentVolumeSpec

	SnapshotCreate(*v1.PersistentVolume) (*crdv1.VolumeSnapshotDataSource, error)

	// SnapshotDelete deletes a VolumeSnapshot

	// PersistentVolume is provided for volume types, if any, that need PV Spec to delete snapshot

	SnapshotDelete(*crdv1.VolumeSnapshotDataSource, *v1.PersistentVolume) error

	// SnapshotRestore restores (promotes) a volume snapshot into a volume

	SnapshotRestore(*crdv1.VolumeSnapshotData, *v1.PersistentVolumeClaim, string, map[string]string) (*v1.PersistentVolumeSource, map[string]string, error)

	// Describe volume snapshot status.

	// return true if the snapshot is ready

	DescribeSnapshot(snapshotData *crdv1.VolumeSnapshotData) (isCompleted bool, err error)

	// VolumeDelete deletes a PV

	// TODO in the future pass kubernetes client for certain volumes (e.g. rbd) so they can access storage class to retrieve secret

	VolumeDelete(pv *v1.PersistentVolume) error

}

```

### Volume Snapshot Data Source Spec

Each volume must also provide a Snapshot Data Source Spec and add to [VolumeSnapshotDataSource](pkg/apis/crd/v1/types.go), then declare support in [GetSupportedVolumeFromPVC](pkg/apis/crd/v1/types.go) by returning the exact name as returned by the plugin's `GetPluginName()`

### Invocation

The plugins are added to Snapshot controller [cmd pkg](cmd/snapshot-controller/snapshot-controller.go).