Skip to content

Commit

Permalink
Update Kanister Docs for DeleteData (#5294)
Browse files Browse the repository at this point in the history
* Update Kanister Docs for DeleteData

* Fix typo

* Add namespace to example

* Adjust spaces
  • Loading branch information
DeepikaDixit authored and Ilya Kislenko committed Mar 29, 2019
1 parent c057e94 commit 2fbc631
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,37 @@ If the ActionSet `Object` is a PersistentVolumeClaim:
volume: "{{ .PVC.Name }}"
dataArtifactPrefix: s3-bucket-name/path
DeleteData
----------

This function deletes the snapshot data backed up by the BackupData function.


.. csv-table::
:header: "Argument", "Required", "Type", "Description"
:align: left
:widths: 5,5,5,15

`namespace`, Yes, `string`, namespace in which to execute
`backupArtifactPrefix`, Yes, `string`, path to the backup on the object store
`backupTag`, Yes, `string`, unique tag added during the backup

Example:

Consider a scenario where you wish to delete the data backed up by the
:ref:`backupdata` function.
For this phase, we will use the `backupInfo` Artifact provided by backup function.

.. code-block:: yaml
:linenos:
- func: DeleteData
name: DeleteFromObjectStore
args:
namespace: "{{ .Namespace.Name }}"
backupArtifactPrefix: s3-bucket/path/artifactPrefix
backupTag: "{{ .ArtifactsIn.backupInfo.KeyValue.backupIdentifier }}"
LocationDelete
--------------

Expand Down

0 comments on commit 2fbc631

Please sign in to comment.