Skip to content

Commit

Permalink
Restic related functions deprecation warning in documentation (#2471)
Browse files Browse the repository at this point in the history
* Add warning regarding BackupData deprecation to documentation

* Add warning regarding BackupDataAll deprecation to documentation

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
e-sumin and mergify[bot] committed Nov 24, 2023
1 parent 2931c5b commit ffbfcfc
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,10 @@ BackupData
This function backs up data from a container into any object store
supported by Kanister.

.. warning::
The *BackupData* will be deprecated soon. We recommend using :ref:`copyvolumedata` instead.
However, :ref:`restoredata` and :ref:`deletedata` will continue to be available, ensuring you retain control over your existing backups.

.. note::
It is important that the application includes a ``kanister-tools``
sidecar container. This sidecar is necessary to run the
Expand Down Expand Up @@ -338,6 +342,10 @@ BackupDataAll
This function concurrently backs up data from one or more pods into an any
object store supported by Kanister.

.. warning::
The *BackupDataAll* will be deprecated soon.
However, :ref:`restoredataall` and :ref:`deletedataall` will continue to be available, ensuring you retain control over your existing backups.

.. note::
It is important that the application includes a ``kanister-tools``
sidecar container. This sidecar is necessary to run the
Expand Down Expand Up @@ -391,7 +399,7 @@ Example:
RestoreData
-----------

This function restores data backed up by the BackupData function.
This function restores data backed up by the :ref:`backupdata` function.
It creates a new Pod that mounts the PVCs referenced by the specified Pod
and restores data to the specified path.

Expand Down Expand Up @@ -536,6 +544,7 @@ BackupDataAll function.
kind: Deployment
replicas: 2

.. _copyvolumedata:

CopyVolumeData
--------------
Expand Down Expand Up @@ -589,10 +598,12 @@ If the ActionSet ``Object`` is a PersistentVolumeClaim:
volume: "{{ .PVC.Name }}"
dataArtifactPrefix: s3-bucket-name/path
.. _deletedata:

DeleteData
----------

This function deletes the snapshot data backed up by the BackupData function.
This function deletes the snapshot data backed up by the :ref:`backupdata` function.


.. csv-table::
Expand Down Expand Up @@ -623,6 +634,8 @@ For this phase, we will use the ``backupInfo`` Artifact provided by backup funct
backupArtifactPrefix: s3-bucket/path/artifactPrefix
backupTag: "{{ .ArtifactsIn.backupInfo.KeyValue.backupIdentifier }}"
.. _deletedataall:

DeleteDataAll
-------------

Expand Down

0 comments on commit ffbfcfc

Please sign in to comment.