Skip to content

Commit

Permalink
docs: add notes about deprecating VolumeSnapshot functions (#2929)
Browse files Browse the repository at this point in the history
Signed-off-by: Daniil Fedotov <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
hairyhum and mergify[bot] authored Feb 10, 2025
1 parent 2fcbdd2 commit 4000634
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 1 deletion.
2 changes: 1 addition & 1 deletion ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Roadmap was moved to [the Wiki page](https://github.com/kanisterio/kanister/wiki/Roadmap)
Roadmap was moved to [the Wiki page](https://github.com/kanisterio/kanister/wiki/Roadmap)
25 changes: 25 additions & 0 deletions docs/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -752,6 +752,12 @@ with an application. It takes individual snapshot of each PVC which can
be then restored later. It generates an output that contains the
Snapshot info required for restoring PVCs.

::: tip WARNING

The *CreateVolumeSnapshot* will be deprecated soon. We recommend using [CreateCSISnapshot](#createcsisnapshot) instead.
CSI snapshotting should have better support for underlying storage providers.
:::

::: tip NOTE

Currently we only support PVC snapshots on AWS EBS. Support for more
Expand Down Expand Up @@ -801,6 +807,12 @@ This function is used to wait for completion of snapshot operations
initiated using the [CreateVolumeSnapshot](#createvolumesnapshot) function.
function.

::: tip WARNING

The *WaitForSnapshotCompletion* will be deprecated soon together with [CreateVolumeSnapshot](#createvolumesnapshot).
We recommend using [CreateCSISnapshot](#createcsisnapshot) instead, which will wait for completion by default.
:::

Arguments:

| Argument | Required | Type | Description |
Expand All @@ -813,6 +825,12 @@ This function is used to restore one or more PVCs of an application from
the snapshots taken using the [CreateVolumeSnapshot](#createvolumesnapshot) function.
It deletes old PVCs, if present and creates new PVCs from the snapshots taken earlier.

::: tip WARNING

The *CreateVolumeFromSnapshot* will be deprecated soon together with [CreateVolumeSnapshot](#createvolumesnapshot). We recommend using CSI snapshotting functions ([CreateCSISnapshot](#createcsisnapshot) and [RestoreCSISnapshot](#restorecsisnapshot)) instead.
CSI snapshotting should have better support for underlying storage providers.
:::

Arguments:

| Argument | Required | Type | Description |
Expand Down Expand Up @@ -854,6 +872,13 @@ by the [CreateVolumeSnapshot](#createvolumesnapshot) function.
This function is used to delete snapshots of PVCs taken using the
[CreateVolumeSnapshot](#createvolumesnapshot) function.


::: tip WARNING

The *DeleteVolumeSnapshot* will be deprecated soon together with [CreateVolumeSnapshot](#createvolumesnapshot). We recommend using CSI snapshotting functions ([CreateCSISnapshot](#createcsisnapshot) and [DeleteCSISnapshot](#deletecsisnapshot)) instead.
CSI snapshotting should have better support for underlying storage providers.
:::

Arguments:

| Argument | Required | Type | Description |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
deprecations:
- Volume snapshot function such as CreateVolumeSnapshot, WaitForSnapshotCompletion, CreateVolumeFromSnapshot and DeleteVolumeSnapshot in favour of CSI snapshot functions

0 comments on commit 4000634

Please sign in to comment.