Re: [heketi-devel] [RFC] Initial proposal for snapshot/cloning support
Hi again!
The majority of the emails still stands, but the document has been
updated a little with early comments. The location is still the same,
and the updated version has been included below.
Niels
On Tue, Feb 13, 2018 at 05:17:44PM +0100, Niels de Vos wrote:
> Hi,
>
> as we would like to see cloning of PVs soonish, I'd like to share my
> suggestions for the heketi-cli and bits of the ReST API that could be
> implemented. The document lives in my fork of the Heketi project and can
> be found here (nicely formatted):
> https://github.com/nixpanic/heketi/blob/wip/snapshot/doc/admin/snapshot.md
>
> It may be easier to reply with inline comments (please not on GitHub),
> so I'll include the text as well.
>
> I hope this interface allows use to support the Snapshot functionality
> that Kubernetes recently added, as well as the cloning of PVs that is
> expected to be consumed by kubevirt.
>
> There are two suggestions for the Endpoints of the API. That is the bit
> that probably needs most consideration.
>
> Suggestions are most welcome!
> Niels
>
%<
Snapshots are read-only copies of volumes that can be used for cloning new
volumes from. Its is possible to create a snapshot through the [Snapshot Create
API](../api/api.md#create-a-snapshot) or the commandline client.
>From the command line client, you can type the following to create a snapshot
from an existing volume:
```
$ heketi-cli snapshot create -volume= [-name=]
```
The new snapshot can be used to create a new volume:
```
$ heketi-cli snapshot clone -from-snap= [-name=]
```
The clones of snapshots are new volumes with the same properties as the
original. The cloned volumes can be deleted with the `heketi-cli volume delete`
command. In a similar fashion, snapshots can be removed with the `heketi-cli
snapshot delete` command.
# Proposed CLI
The parameters for the `heketi-cli` should be easily identifiable. Every time a
`` is used, the parameter will be called `-volume=`, and the same
counts for `` and `-snapshot=`. Upon creation, the name of the new
object can be passed as `-name=`, or left out so that Heketi generates a name
based on the UUID that will be assigned to the object.
```
$ heketi-cli snapshot create -volume= [-name=]
[-description=]
$ heketi-cli snapshot clone -snapshot= [-name=]
$ heketi-cli snapshot delete -snapshot=
$ heketi-cli snapshot list -volume=
$ heketi-cli snapshot info -snapshot=
```
# API Proposal
For file volume types only. A similar implementation might get added for
block-volumes at a later time.
### Create a Snapshot
* **Method:** _POST_
* **Endpoint**:`/volumes/{volume_uuid}/snapshots`
### Clone a Volume from a Snapshot
* **Method:** _POST_
* **Endpoint**:`/volumes/{volume_uuid}/snapshots/{snapshot_uuid}`
### Delete a Snapshot
* **Method:** _DELETE_
* **Endpoint**:`/volumes/{volume_uuid}/snapshots/{snapshot_uuid}`
### List Snapshots
* **Method:** _GET_
* **Endpoint**:`/volumes/{volume_uuid}/snapshots`
### Get Snapshot Information
* **Method:** _GET_
* **Endpoint**:`/volumes/{volume_uuid}/snapshots/{snapshot_uuid}`
# Gluster Snapshot CLI Reference
```
$ gluster --log-file=/dev/null snapshot help
gluster snapshot commands
=
snapshot activate [force] - Activate snapshot volume.
snapshot clone - Snapshot Clone.
snapshot config [volname] ([snap-max-hard-limit ] [snap-max-soft-limit
]) | ([auto-delete ])| ([activate-on-create
]) - Snapshot Config.
snapshot create [no-timestamp] [description ]
[force] - Snapshot Create.
snapshot deactivate - Deactivate snapshot volume.
snapshot delete (all | snapname | volume ) - Snapshot Delete.
snapshot help - display help for snapshot commands
snapshot info [(snapname | volume )] - Snapshot Info.
snapshot list [volname] - Snapshot List.
snapshot restore - Snapshot Restore.
snapshot status [(snapname | volume )] - Snapshot Status.
```
-
[Snapshot](https://github.com/gluster/glusterfs-specs/blob/master/done/GlusterFS%203.6/Gluster%20Volume%20Snapshot.md)
-
[Cloning](https://github.com/gluster/glusterfs-specs/blob/master/done/GlusterFS%203.7/Clone%20of%20Snapshot.md)
___
heketi-devel mailing list
heketi-devel@gluster.org
http://lists.gluster.org/mailman/listinfo/heketi-devel
[heketi-devel] [RFC] Initial proposal for snapshot/cloning support
Hi,
as we would like to see cloning of PVs soonish, I'd like to share my
suggestions for the heketi-cli and bits of the ReST API that could be
implemented. The document lives in my fork of the Heketi project and can
be found here (nicely formatted):
https://github.com/nixpanic/heketi/blob/wip/snapshot/doc/admin/snapshot.md
It may be easier to reply with inline comments (please not on GitHub),
so I'll include the text as well.
I hope this interface allows use to support the Snapshot functionality
that Kubernetes recently added, as well as the cloning of PVs that is
expected to be consumed by kubevirt.
There are two suggestions for the Endpoints of the API. That is the bit
that probably needs most consideration.
Suggestions are most welcome!
Niels
%<
Snapshots are read-only copies of volumes that can be used for cloning new
volumes from. Its is possible to create a snapshot through the [Snapshot Create
API](../api/api.md#create-a-snapshot) or the commandline client.
>From the command line client, you can type the following to create a snapshot
from an existing volume:
```
$ heketi-cli snapshot create -volume= [-name=]
```
The new snapshot can be used to create a new volume:
```
$ heketi-cli snapshot clone -from-snap= [-name=]
```
The clones of snapshots are new volumes with the same proporties as the
original. The cloned volumes can be deleted with the `heketi-cli volume delete`
command. In a similar fashion, snapshots can be removed with the `heketi-cli
snapshot delete` command.
# Proposed CLI
```
$ heketi-cli snapshot create -volume= [-name=]
[-description=]
$ heketi-cli snapshot clone -volume= [-name=]
$ heketi-cli snapshot delete -name=
$ heketi-cli snapshot list [-volume=]
$ heketi-cli snapshot info -name=
```
# API Proposals
## Under the `/volumes` Endpoint
- [x] simple interface, extension to a volume object
- [ ] needs to duplicated/implemented for block-volumes
### Create a Snapshot
* **Method:** _POST_
* **Endpoint**:`/volumes/{volume_uuid}/snapshots`
### Clone a Snapshot
* **Method:** _POST_
* **Endpoint**:`/volumes/{volume_uuid}/clone`
### Delete a Snapshot
* **Method:** _DELETE_
* **Endpoint**:`/volumes/{volume_uuid}/snapshots/{snapshot_uuid}`
### List Snapshots
* **Method:** _GET_
* **Endpoint**:`/volumes/{volume_uuid}/snapshots`
### Get Snapshot Information
* **Method:** _GET_
* **Endpoint**:`/volumes/{volume_uuid}/snapshots/{snapshot_uuid}`
## Under the `/snapshots` Endpoint
- [x] simple interface, introduces a new snapshot object
- [x] can be used transparantly for both file+block volumes
- [ ] ugly(?) mixture of file+block volume objects
- [ ] needs to track source (file/block) of the snapshot
### Create a Snapshot
* **Method:** _POST_
* **Endpoint**:`/snapshots/{volume_uuid}`
### Clone a Snapshot
* **Method:** _POST_
* **Endpoint**:`/snapshots/{volume_uuid}/clone`
### Delete a Snapshot
* **Method:** _DELETE_
* **Endpoint**:`/snapshots/{volume_uuid}`
### List Snapshots
* **Method:** _GET_
* **Endpoint**:`/snapshots/{volume_uuid}`
### Get Snapshot Information
* **Method:** _GET_
* **Endpoint**:`/snapshots/{volume_uuid}/{snapshot_uuid}`
# Gluster Snapshot CLI Reference
```
$ gluster --log-file=/dev/null snapshot help
gluster snapshot commands
=
snapshot activate [force] - Activate snapshot volume.
snapshot clone - Snapshot Clone.
snapshot config [volname] ([snap-max-hard-limit ] [snap-max-soft-limit
]) | ([auto-delete ])| ([activate-on-create
]) - Snapshot Config.
snapshot create [no-timestamp] [description ]
[force] - Snapshot Create.
snapshot deactivate - Deactivate snapshot volume.
snapshot delete (all | snapname | volume ) - Snapshot Delete.
snapshot help - display help for snapshot commands
snapshot info [(snapname | volume )] - Snapshot Info.
snapshot list [volname] - Snapshot List.
snapshot restore - Snapshot Restore.
snapshot status [(snapname | volume )] - Snapshot Status.
```
-
[Snapshot](https://github.com/gluster/glusterfs-specs/blob/master/done/GlusterFS%203.6/Gluster%20Volume%20Snapshot.md)
-
[Cloning](https://github.com/gluster/glusterfs-specs/blob/master/done/GlusterFS%203.7/Clone%20of%20Snapshot.md)
___
heketi-devel mailing list
heketi-devel@gluster.org
http://lists.gluster.org/mailman/listinfo/heketi-devel
