Skip to content

Commit

Permalink
DeleteData doc update (kanisterio#3187)
Browse files Browse the repository at this point in the history
  • Loading branch information
pavannd1 authored and tdmanv committed Jun 18, 2018
1 parent f9fa616 commit 1c263d9
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,36 @@ Example:
backupArtifact: s3://bucket/path/artifact
restorePath: /mnt/data
DeleteData
----------

This function uses a Kubernetes Job to delete the specified artifact
from an S3 compatible object store.

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

`namespace`, No, `string`, namespace in which to execute
`artifact`, Yes, `string`, artifact to be deleted from the object store

.. note::
The Kubernetes job uses the `kanisterio/kanister-tools` image,
since it includes all the tools required to delete the artifact
from an S3 compatible object store.

Example:

.. code-block:: yaml
:linenos:
- func: DeleteData
name: DeleteFromObjectStore
args:
namespace: "{{ .Deployment.Namespace }}"
artifact: s3://bucket/path/artifact
Registering Functions
---------------------

Expand Down

0 comments on commit 1c263d9

Please sign in to comment.