Skip to content

Commit

Permalink
Kanister docs correct argument DeleteData (#779)
Browse files Browse the repository at this point in the history
* Kanister docs correct argument DeleteData

See https://github.com/kanisterio/kanister/blob/ea72b13de3631fce145629b4acac72871f3c4bfe/pkg/function/delete_data.go#L42

* Add backupIdentifier to wordlist

Co-authored-by: Pavan Navarathna <pavan@kasten.io>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored Dec 11, 2020
1 parent 358291c commit d6d6e06
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -597,8 +597,8 @@ This function deletes the snapshot data backed up by the BackupData function.

`namespace`, Yes, `string`, namespace in which to execute
`backupArtifactPrefix`, Yes, `string`, path to the backup on the object store
`backupIdentifier`, No, `string`, (required if backupTag not provided) unique snapshot id generated during backup
`backupTag`, No, `string`, (required if backupIdentifier not provided) unique tag added during the backup
`backupID`, No, `string`, (required if backupTag not provided) unique snapshot id generated during backup
`backupTag`, No, `string`, (required if backupID not provided) unique tag added during the backup
`encryptionKey`, No, `string`, encryption key to be used during backups
`podOverride`, No, `map[string]interface{}`, specs to override default pod specs with

Expand Down
1 change: 1 addition & 0 deletions docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ actionset
args
aws
backupIdentifier
backupID
backupInfo
backupTag
boolean
Expand Down

0 comments on commit d6d6e06

Please sign in to comment.