Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Restic related functions deprecation warning in documentation #2471

Merged
merged 3 commits into from
Nov 24, 2023
Merged

Restic related functions deprecation warning in documentation #2471

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
580447f
Add warning regarding BackupData deprecation to documentation
e-sumin Nov 8, 2023
755ca2e
Add warning regarding BackupDataAll deprecation to documentation
e-sumin Nov 8, 2023
64da22e
Merge branch 'master' into pre-deprecate-restic
mergify[bot] Nov 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 15 additions & 2 deletions docs/functions.rst
View file
Open in desktop
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